Interface ISimulations
Gives access to simulations.
Namespace: TopSolid.Cad.Design.Automating
Assembly: TopSolid.Cad.Design.Automating.dll
Syntax
[ServiceContract]
[AvailableSinceVersion(7, 6, 0, 0)]
public interface ISimulationsRemarks
This interface is available since v7.6.
Methods
CreateForcesDrivingTask(DocumentId, ForceDrivingInterpolationType, List<SmartReal>, List<ElementId>, List<List<SmartReal>>)
Creates a forces driving task in a specified document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateForcesDrivingTask(DocumentId inDocumentId, ForceDrivingInterpolationType inInterpolationType, List<SmartReal> inTimes, List<ElementId> inForceIds, List<List<SmartReal>> inValues)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| ForceDrivingInterpolationType | inInterpolationType | Interpolation type. |
| List<SmartReal> | inTimes | Times. |
| List<ElementId> | inForceIds | Identifiers of forces to drive. |
| List<List<SmartReal>> | inValues | Forces driving values. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created task. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
CreateGripChangeTask(DocumentId, Boolean, ElementId, List<ElementId>)
Creates a grip change task in a specified document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateGripChangeTask(DocumentId inDocumentId, bool inIsGripping, ElementId inGrippingRigidGroupId, List<ElementId> inRigidGroupIds)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| Boolean | inIsGripping | Whether the task is gripping, or otherwise dropping. |
| ElementId | inGrippingRigidGroupId | Identifier of gripping rigid group. |
| List<ElementId> | inRigidGroupIds | Identifiers of rigid groups that are gripped or dropped. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created task. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
CreateJointsDrivingTask(DocumentId, JointDrivingType, JointDrivingInterpolationType, List<SmartReal>, List<ElementId>, List<List<SmartReal>>)
Creates a joints driving task in a specified document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateJointsDrivingTask(DocumentId inDocumentId, JointDrivingType inType, JointDrivingInterpolationType inInterpolationType, List<SmartReal> inTimes, List<ElementId> inJointIds, List<List<SmartReal>> inValues)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| JointDrivingType | inType | Driving type. |
| JointDrivingInterpolationType | inInterpolationType | Interpolation type. |
| List<SmartReal> | inTimes | Times. |
| List<ElementId> | inJointIds | Identifiers of joints to drive. |
| List<List<SmartReal>> | inValues | Joints driving values. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created task. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
CreateKinematicsSimulation(DocumentId, ElementId, ElementId, SmartInteger, SmartInteger, Boolean)
Creates a kinematics simutation operation in a specified document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateKinematicsSimulation(DocumentId inDocumentId, ElementId inStartConfigurationId, ElementId inScenarioId, SmartInteger inPositionsPerSecond, SmartInteger inStepsPerPosition, bool inIsRefreshAuto)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| ElementId | inStartConfigurationId | Identifier of start configuration. |
| ElementId | inScenarioId | Identifier of scenario. |
| SmartInteger | inPositionsPerSecond | Number of positions per second. |
| SmartInteger | inStepsPerPosition | Number of computed steps per position. |
| Boolean | inIsRefreshAuto | Whether refresh is automatic. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created simulation entity. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
CreateRigidGroupDrivingTask(DocumentId, RigidGroupDrivingType, ElementId, SmartFrame3D, List<SmartReal>, List<SmartReal>, List<SmartReal>, List<SmartReal>, List<SmartReal>, List<SmartReal>, List<SmartReal>, List<Boolean>)
Creates a rigid group driving task in a specified document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateRigidGroupDrivingTask(DocumentId inDocumentId, RigidGroupDrivingType inType, ElementId inRigidGroupId, SmartFrame3D inDrivingFrame, List<SmartReal> inTimes, List<SmartReal> inRotationsX, List<SmartReal> inRotationsY, List<SmartReal> inRotationsZ, List<SmartReal> inTranslationsX, List<SmartReal> inTranslationsY, List<SmartReal> inTranslationsZ, List<bool> inIsCirculars)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| RigidGroupDrivingType | inType | Driving type. |
| ElementId | inRigidGroupId | Identifier of definition of rigid group to drive. |
| SmartFrame3D | inDrivingFrame | Driving frame. |
| List<SmartReal> | inTimes | Times. |
| List<SmartReal> | inRotationsX | Rotations X component. |
| List<SmartReal> | inRotationsY | Rotations Y component. |
| List<SmartReal> | inRotationsZ | Rotations Z component. |
| List<SmartReal> | inTranslationsX | Translations X component. |
| List<SmartReal> | inTranslationsY | Translations Y component. |
| List<SmartReal> | inTranslationsZ | Translations Z component. |
| List<Boolean> | inIsCirculars | Whether to use circular interpolation. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created task. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
CreateScenario(DocumentId, List<Byte>, List<String>, List<ElementId>, List<Boolean>, List<SmartReal>, List<Byte>)
Creates a scenario in a specified document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateScenario(DocumentId inDocumentId, List<byte> inTrackIds, List<string> inTrackNames, List<ElementId> inTaskIds, List<bool> inTaskIsActives, List<SmartReal> inTaskStartTimes, List<byte> inTaskTrackIds)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| List<Byte> | inTrackIds | Tracks identifiers. |
| List<String> | inTrackNames | Tracks names. |
| List<ElementId> | inTaskIds | Tasks identifiers. |
| List<Boolean> | inTaskIsActives | Whether the tasks are active. |
| List<SmartReal> | inTaskStartTimes | Tasks start times. |
| List<Byte> | inTaskTrackIds | Tasks tracks identifiers. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created scenario. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
CreateVisibilityChangeTask(DocumentId, Boolean, List<ElementId>)
Creates a visibility change task in a specified document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateVisibilityChangeTask(DocumentId inDocumentId, bool inIsHiding, List<ElementId> inRigidGroupIds)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| Boolean | inIsHiding | Whether the task is hiding, or otherwise showing. |
| List<ElementId> | inRigidGroupIds | Identifiers of rigid groups that are changing. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created task. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
GetCurrentSimulation(DocumentId)
Gets the current simulation entity of a document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetCurrentSimulation(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the current simulation entity found, or Empty for none. |
Remarks
This method is available since v7.6.
GetForcesDrivingTask(ElementId, out ForceDrivingInterpolationType, out List<SmartReal>, out List<ElementId>, out List<List<SmartReal>>)
Gets a forces driving task.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
void GetForcesDrivingTask(ElementId inElementId, out ForceDrivingInterpolationType outInterpolationType, out List<SmartReal> outTimes, out List<ElementId> outForceIds, out List<List<SmartReal>> outValues)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the task to analyze. |
| ForceDrivingInterpolationType | outInterpolationType | Interpolation type. |
| List<SmartReal> | outTimes | Times. |
| List<ElementId> | outForceIds | Identifiers of forces to drive. |
| List<List<SmartReal>> | outValues | Forces driving values. |
Remarks
This method is available since v7.6.
GetGripChangeTask(ElementId, out Boolean, out ElementId, out List<ElementId>)
Gets a grip change task.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
void GetGripChangeTask(ElementId inElementId, out bool outIsGripping, out ElementId outGrippingRigidGroupId, out List<ElementId> outRigidGroupIds)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the task to analyze. |
| Boolean | outIsGripping | Whether the task is gripping, or otherwise dropping. |
| ElementId | outGrippingRigidGroupId | Identifier of gripping rigid group. |
| List<ElementId> | outRigidGroupIds | Identifiers of rigid groups that are gripped or dropped. |
Remarks
This method is available since v7.6.
GetJointsDrivingTask(ElementId, out JointDrivingType, out JointDrivingInterpolationType, out List<SmartReal>, out List<ElementId>, out List<List<SmartReal>>)
Gets a joints driving task.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
void GetJointsDrivingTask(ElementId inElementId, out JointDrivingType outType, out JointDrivingInterpolationType outInterpolationType, out List<SmartReal> outTimes, out List<ElementId> outJointIds, out List<List<SmartReal>> outValues)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the task to analyze. |
| JointDrivingType | outType | Driving type. |
| JointDrivingInterpolationType | outInterpolationType | Interpolation type. |
| List<SmartReal> | outTimes | Times. |
| List<ElementId> | outJointIds | Identifiers of joints to drive. |
| List<List<SmartReal>> | outValues | Joints driving values. |
Remarks
This method is available since v7.6.
GetRigidGroupDrivingTask(ElementId, out RigidGroupDrivingType, out ElementId, out SmartFrame3D, out List<SmartReal>, out List<SmartReal>, out List<SmartReal>, out List<SmartReal>, out List<SmartReal>, out List<SmartReal>, out List<SmartReal>, out List<Boolean>)
Gets a rigid group driving task.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
void GetRigidGroupDrivingTask(ElementId inElementId, out RigidGroupDrivingType outType, out ElementId outRigidGroupId, out SmartFrame3D outDrivingFrame, out List<SmartReal> outTimes, out List<SmartReal> outRotationsX, out List<SmartReal> outRotationsY, out List<SmartReal> outRotationsZ, out List<SmartReal> outTranslationsX, out List<SmartReal> outTranslationsY, out List<SmartReal> outTranslationsZ, out List<bool> outIsCirculars)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the task to analyze. |
| RigidGroupDrivingType | outType | Driving type. |
| ElementId | outRigidGroupId | Identifier of definition of rigid group to drive. |
| SmartFrame3D | outDrivingFrame | Driving frame. |
| List<SmartReal> | outTimes | Times. |
| List<SmartReal> | outRotationsX | Rotations X component. |
| List<SmartReal> | outRotationsY | Rotations Y component. |
| List<SmartReal> | outRotationsZ | Rotations Z component. |
| List<SmartReal> | outTranslationsX | Translations X component. |
| List<SmartReal> | outTranslationsY | Translations Y component. |
| List<SmartReal> | outTranslationsZ | Translations Z component. |
| List<Boolean> | outIsCirculars | Whether to use circular interpolation. |
Remarks
This method is available since v7.6.
GetScenario(ElementId, out List<Byte>, out List<String>, out List<ElementId>, out List<Boolean>, out List<SmartReal>, out List<Byte>)
Gets a scenario.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
void GetScenario(ElementId inElementId, out List<byte> outTrackIds, out List<string> outTrackNames, out List<ElementId> outTaskIds, out List<bool> outTaskIsActives, out List<SmartReal> outTaskStartTimes, out List<byte> outTaskTrackIds)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the scenario to analyze. |
| List<Byte> | outTrackIds | Tracks identifiers. |
| List<String> | outTrackNames | Tracks names, or null for automatic. |
| List<ElementId> | outTaskIds | Tasks identifiers. |
| List<Boolean> | outTaskIsActives | Whether the tasks are active. |
| List<SmartReal> | outTaskStartTimes | Tasks start times. |
| List<Byte> | outTaskTrackIds | Tasks tracks identifiers. |
Remarks
This method is available since v7.6.
GetScenarios(DocumentId)
Gets the scenarios entities that are in the scenarios folder of a document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
List<ElementId> GetScenarios(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementId> | Scenarios entities found. |
Remarks
This method is available since v7.6.
GetSimulations(DocumentId)
Gets the simulation entities that are in the simulations folder of a document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
List<ElementId> GetSimulations(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementId> | Simulation entities found. |
Remarks
This method is available since v7.6.
GetTasks(DocumentId)
Gets the tasks entities that are in the tasks folder of a document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
List<ElementId> GetTasks(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementId> | Tasks entities found. |
Remarks
This method is available since v7.6.
GetTaskType(ElementId)
Gets the type of a task entity.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
TaskType GetTaskType(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the element to analyze. |
Returns
| Type | Description |
|---|---|
| TaskType | Type of the task, or None if the element is not a task entity. |
Remarks
This method is available since v7.6.
GetVisibilityChangeTask(ElementId, out Boolean, out List<ElementId>)
Gets a visibility change task.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
void GetVisibilityChangeTask(ElementId inElementId, out bool outIsHiding, out List<ElementId> outRigidGroupIds)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the task to analyze. |
| Boolean | outIsHiding | Whether the task is hiding, or otherwise showing. |
| List<ElementId> | outRigidGroupIds | Identifiers of rigid groups that are changing. |
Remarks
This method is available since v7.6.
SetCurrentSimulation(DocumentId, ElementId)
Sets the current simulation entity of a document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
void SetCurrentSimulation(DocumentId inDocumentId, ElementId inSimulationId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| ElementId | inSimulationId | Identifier of the new current simulation entity. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
SetForcesDrivingTask(ElementId, ForceDrivingInterpolationType, List<SmartReal>, List<ElementId>, List<List<SmartReal>>)
Sets a forces driving task.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
void SetForcesDrivingTask(ElementId inElementId, ForceDrivingInterpolationType inInterpolationType, List<SmartReal> inTimes, List<ElementId> inForceIds, List<List<SmartReal>> inValues)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the task to modify. |
| ForceDrivingInterpolationType | inInterpolationType | Interpolation type. |
| List<SmartReal> | inTimes | Times. |
| List<ElementId> | inForceIds | Identifiers of forces to drive. |
| List<List<SmartReal>> | inValues | Forces driving values. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
SetGripChangeTask(ElementId, Boolean, ElementId, List<ElementId>)
Sets a grip change task.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
void SetGripChangeTask(ElementId inElementId, bool inIsGripping, ElementId inGrippingRigidGroupId, List<ElementId> inRigidGroupIds)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the task to modify. |
| Boolean | inIsGripping | Whether the task is gripping, or otherwise dropping. |
| ElementId | inGrippingRigidGroupId | Identifier of gripping rigid group. |
| List<ElementId> | inRigidGroupIds | Identifiers of rigid groups that are gripped or dropped. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
SetJointsDrivingTask(ElementId, JointDrivingType, JointDrivingInterpolationType, List<SmartReal>, List<ElementId>, List<List<SmartReal>>)
Sets a joints driving task.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
void SetJointsDrivingTask(ElementId inElementId, JointDrivingType inType, JointDrivingInterpolationType inInterpolationType, List<SmartReal> inTimes, List<ElementId> inJointIds, List<List<SmartReal>> inValues)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the task to modify. |
| JointDrivingType | inType | Driving type. |
| JointDrivingInterpolationType | inInterpolationType | Interpolation type. |
| List<SmartReal> | inTimes | Times. |
| List<ElementId> | inJointIds | Identifiers of joints to drive. |
| List<List<SmartReal>> | inValues | Joints driving values. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
SetRigidGroupDrivingTask(ElementId, RigidGroupDrivingType, ElementId, SmartFrame3D, List<SmartReal>, List<SmartReal>, List<SmartReal>, List<SmartReal>, List<SmartReal>, List<SmartReal>, List<SmartReal>, List<Boolean>)
Sets a rigid group driving task.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
void SetRigidGroupDrivingTask(ElementId inElementId, RigidGroupDrivingType inType, ElementId inRigidGroupId, SmartFrame3D inDrivingFrame, List<SmartReal> inTimes, List<SmartReal> inRotationsX, List<SmartReal> inRotationsY, List<SmartReal> inRotationsZ, List<SmartReal> inTranslationsX, List<SmartReal> inTranslationsY, List<SmartReal> inTranslationsZ, List<bool> inIsCirculars)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the task to modify. |
| RigidGroupDrivingType | inType | Driving type. |
| ElementId | inRigidGroupId | Identifier of definition of rigid group to drive. |
| SmartFrame3D | inDrivingFrame | Driving frame. |
| List<SmartReal> | inTimes | Times. |
| List<SmartReal> | inRotationsX | Rotations X component. |
| List<SmartReal> | inRotationsY | Rotations Y component. |
| List<SmartReal> | inRotationsZ | Rotations Z component. |
| List<SmartReal> | inTranslationsX | Translations X component. |
| List<SmartReal> | inTranslationsY | Translations Y component. |
| List<SmartReal> | inTranslationsZ | Translations Z component. |
| List<Boolean> | inIsCirculars | Whether to use circular interpolation. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
SetVisibilityChangeTask(ElementId, Boolean, List<ElementId>)
Sets a visibility change task.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
void SetVisibilityChangeTask(ElementId inElementId, bool inIsHiding, List<ElementId> inRigidGroupIds)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the task to modify. |
| Boolean | inIsHiding | Whether the task is hiding, or otherwise showing. |
| List<ElementId> | inRigidGroupIds | Identifiers of rigid groups that are changing. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.