Interface IAssemblies
Gives access to assemblies.
Namespace: TopSolid.Cad.Design.Automating
Assembly: TopSolid.Cad.Design.Automating.dll
Syntax
[ServiceContract]
[AvailableSinceVersion(7, 6, 0, 0)]
public interface IAssembliesRemarks
This interface is available since v7.6.
Methods
AskOccurrence(UserQuestion, Boolean, Boolean, Boolean, Boolean, Boolean, ElementId, out ElementId)
Asks the user for a part or an assembly occurrence.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
UserAnswerType AskOccurrence(UserQuestion inQuestion, bool inAcceptsPositioned, bool inAcceptsInPlace, bool inAcceptsPart, bool inAcceptsAssembly, bool inAcceptsMechanism, ElementId inSuggestion, out ElementId outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| System.Boolean | inAcceptsPositioned | Accepts positioned occurrence. |
| System.Boolean | inAcceptsInPlace | Accepts in-place occurrence. |
| System.Boolean | inAcceptsPart | Accepts part occurrence. |
| System.Boolean | inAcceptsAssembly | Accepts assembly occurrence. |
| System.Boolean | inAcceptsMechanism | Accepts mechanism occurrence. |
| ElementId | inSuggestion | Suggested answer, or Empty if none. |
| ElementId | outAnswer | User answer, or Empty if none. |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
Only occurrences that are directly in the parts folder of the document may be obtained by this method, not "deep" occurrences that are inside them.
This method is available since v7.10.
CreateDisassembly(ElementId, Boolean)
Creates the disassembly operation of an assembly entity.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 17, 300, 80)]
ElementId CreateDisassembly(ElementId inAssemblyId, bool inInheritsAuxiliaryElements)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inAssemblyId | Identifier of the assembly entity to modify. |
| System.Boolean | inInheritsAuxiliaryElements | Tells wehter auxiliary elements must be inherited. |
Returns
| Type | Description |
|---|---|
| ElementId | The created disassembly operation. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.17.
CreateFixedConstraint(ElementId)
Creates a fixed constraint of a positioning.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 15, 400, 120)]
ElementId CreateFixedConstraint(ElementId inOccurrenceId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inOccurrenceId | Identifier of the occurrence of the part or assembly to fix. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created constraint. |
Remarks
This method is available since v7.15.400.120.
CreateFrameOnFrameConstraint(ElementId, SmartFrame3D, SmartFrame3D, SmartReal, Boolean, SmartReal, Boolean, SmartReal, Boolean, SmartReal, Boolean, Boolean)
Creates a "frame on frame" positioning constraint.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
ElementId CreateFrameOnFrameConstraint(ElementId inPositioningId, SmartFrame3D inSourceFrame, SmartFrame3D inDestinationFrame, SmartReal inOffsetDistance, bool inIsOffsetReversed, SmartReal inXRotationAngle, bool inIsXRotationReversed, SmartReal inYRotationAngle, bool inIsYRotationReversed, SmartReal inZRotationAngle, bool inIsZRotationReversed, bool inRotatesZYX)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inPositioningId | Identifier of the positioning operation that will contain the constraint. |
| SmartFrame3D | inSourceFrame | Frame on source occurrence. |
| SmartFrame3D | inDestinationFrame | Destination frame. |
| SmartReal | inOffsetDistance | Offset distance of the source frame along the destination frame Z direction. |
| System.Boolean | inIsOffsetReversed | Whether the offset is reversed. |
| SmartReal | inXRotationAngle | Rotation angle of the source frame around its X axis. |
| System.Boolean | inIsXRotationReversed | Whether the rotation around X is reversed. |
| SmartReal | inYRotationAngle | Rotation angle of the source frame around its Y axis. |
| System.Boolean | inIsYRotationReversed | Whether the rotation around Y is reversed. |
| SmartReal | inZRotationAngle | Rotation angle of the source frame around its Z axis. |
| System.Boolean | inIsZRotationReversed | Whether the rotation around Z is reversed. |
| System.Boolean | inRotatesZYX | Rotates around Z then Y then X instead of X then Y then Z. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created constraint. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.8.
CreateFrameOnFrameConstraintWithXYOffsets(ElementId, SmartFrame3D, SmartFrame3D, SmartReal, Boolean, SmartReal, Boolean, SmartReal, Boolean, SmartReal, Boolean, SmartReal, Boolean, SmartReal, Boolean, Boolean)
Creates a "frame on frame" positioning constraint with X and Y offsets.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 9, 0, 0)]
ElementId CreateFrameOnFrameConstraintWithXYOffsets(ElementId inPositioningId, SmartFrame3D inSourceFrame, SmartFrame3D inDestinationFrame, SmartReal inXOffsetDistance, bool inIsXOffsetReversed, SmartReal inYOffsetDistance, bool inIsYOffsetReversed, SmartReal inZOffsetDistance, bool inIsZOffsetReversed, SmartReal inXRotationAngle, bool inIsXRotationReversed, SmartReal inYRotationAngle, bool inIsYRotationReversed, SmartReal inZRotationAngle, bool inIsZRotationReversed, bool inRotatesZYX)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inPositioningId | Identifier of the positioning operation that will contain the constraint. |
| SmartFrame3D | inSourceFrame | Frame on source occurrence. |
| SmartFrame3D | inDestinationFrame | Destination frame. |
| SmartReal | inXOffsetDistance | Offset distance of the source frame along the destination frame X direction. |
| System.Boolean | inIsXOffsetReversed | Whether the X offset is reversed. |
| SmartReal | inYOffsetDistance | Offset distance of the source frame along the destination frame Y direction. |
| System.Boolean | inIsYOffsetReversed | Whether the Y offset is reversed. |
| SmartReal | inZOffsetDistance | Offset distance of the source frame along the destination frame Z direction. |
| System.Boolean | inIsZOffsetReversed | Whether the Z offset is reversed. |
| SmartReal | inXRotationAngle | Rotation angle of the source frame around its X axis. |
| System.Boolean | inIsXRotationReversed | Whether the rotation around X is reversed. |
| SmartReal | inYRotationAngle | Rotation angle of the source frame around its Y axis. |
| System.Boolean | inIsYRotationReversed | Whether the rotation around Y is reversed. |
| SmartReal | inZRotationAngle | Rotation angle of the source frame around its Z axis. |
| System.Boolean | inIsZRotationReversed | Whether the rotation around Z is reversed. |
| System.Boolean | inRotatesZYX | Rotates around Z then Y then X instead of X then Y then Z. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created constraint. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.9.
CreateInclusion(DocumentId, ElementId, String, DocumentId, String, List<String>, List<SmartObject>, Boolean, ElementId, ElementId, Boolean, Boolean, Boolean, Boolean, Transform3D, Boolean)
Creates an inclusion operation in a document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 7, 0, 0)]
ElementId CreateInclusion(DocumentId inDocumentId, ElementId inPositioningId, string inOccurrenceName, DocumentId inDefinitionId, string inCode, List<string> inDriverNames, List<SmartObject> inDriverValues, bool inAutomaticallyFillsRepresentations, ElementId inConfigurationId, ElementId inRigidGroupId, bool inIsRigid, bool inInheritsRigidGroups, bool inInheritsJoints, bool inInheritsForces, Transform3D inTransform, bool inIsFixed)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| ElementId | inPositioningId | Identifier of the positioning operation that will contain the inclusion, or Empty for creating a new one. |
| System.String | inOccurrenceName | Occurrence name, or null if none. |
| DocumentId | inDefinitionId | Identifier of the definition document of the part or assembly or family to include. |
| System.String | inCode | Instance code, or null if none. |
| System.Collections.Generic.List<System.String> | inDriverNames | Instance driver names, or null if none. |
| System.Collections.Generic.List<SmartObject> | inDriverValues | Instance driver values, or null if none. |
| System.Boolean | inAutomaticallyFillsRepresentations | Automatically fills assembly representations with corresponding representations of mechanical document to include. |
| ElementId | inConfigurationId | Identifier of the configuration to use when including a mechanism assembly, or Empty otherwise. |
| ElementId | inRigidGroupId | Identifier of the rigid group in which to put new node entity, or Empty otherwise. |
| System.Boolean | inIsRigid | Whether to make a rigid inclusion when including a mechanism sub-assembly. |
| System.Boolean | inInheritsRigidGroups | Whether to inherit sub-assembly rigid groups (when |
| System.Boolean | inInheritsJoints | Whether to inherit sub-assembly joints (when |
| System.Boolean | inInheritsForces | Whether to inherit sub-assembly forces (when |
| Transform3D | inTransform | Transformation to apply. |
| System.Boolean | inIsFixed | Whether to fix the result of the inclusion. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created inclusion operation. |
Remarks
Code is not null if document to include is a family which has a catalog.
Driver names and values are not null if document to include is a family which has drivers. In this case, driver names and values must match.
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.7.
Automatic creation of the positioning by specifying inPositioningId = Empty is available since v7.8.
CreateInclusion2(DocumentId, ElementId, String, DocumentId, String, List<String>, List<SmartObject>, List<String>, List<SmartDesignObject>, Boolean, ElementId, ElementId, Boolean, Boolean, Boolean, Boolean, Transform3D, Boolean)
Creates an inclusion operation in a document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
ElementId CreateInclusion2(DocumentId inDocumentId, ElementId inPositioningId, string inOccurrenceName, DocumentId inDefinitionId, string inCode, List<string> inKernelDriverNames, List<SmartObject> inKernelDriverValues, List<string> inDesignDriverNames, List<SmartDesignObject> inDesignDriverValues, bool inAutomaticallyFillsRepresentations, ElementId inConfigurationId, ElementId inRigidGroupId, bool inIsRigid, bool inInheritsRigidGroups, bool inInheritsJoints, bool inInheritsForces, Transform3D inTransform, bool inIsFixed)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| ElementId | inPositioningId | Identifier of the positioning operation that will contain the inclusion, or Empty for creating a new one. |
| System.String | inOccurrenceName | Occurrence name, or null if none. |
| DocumentId | inDefinitionId | Identifier of the definition document of the part or assembly or family to include. |
| System.String | inCode | Instance code, or null if none. |
| System.Collections.Generic.List<System.String> | inKernelDriverNames | Instance kernel driver names, or null if none. |
| System.Collections.Generic.List<SmartObject> | inKernelDriverValues | Instance kernel driver values, or null if none. |
| System.Collections.Generic.List<System.String> | inDesignDriverNames | Instance design driver names, or null if none. |
| System.Collections.Generic.List<SmartDesignObject> | inDesignDriverValues | Instance design driver values, or null if none. |
| System.Boolean | inAutomaticallyFillsRepresentations | Automatically fills assembly representations with corresponding representations of mechanical document to include. |
| ElementId | inConfigurationId | Identifier of the configuration to use when including a mechanism assembly, or Empty otherwise. |
| ElementId | inRigidGroupId | Identifier of the rigid group in which to put new node entity, or Empty otherwise. |
| System.Boolean | inIsRigid | Whether to make a rigid inclusion when including a mechanism sub-assembly. |
| System.Boolean | inInheritsRigidGroups | Whether to inherit sub-assembly rigid groups (when |
| System.Boolean | inInheritsJoints | Whether to inherit sub-assembly joints (when |
| System.Boolean | inInheritsForces | Whether to inherit sub-assembly forces (when |
| Transform3D | inTransform | Transformation to apply. |
| System.Boolean | inIsFixed | Whether to fix the result of the inclusion. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created inclusion operation. |
Remarks
Code is not null if document to include is a family which has a catalog.
Driver names and values are not null if document to include is a family which has drivers. In this case, driver names and values must match.
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.17.
Automatic creation of the positioning by specifying inPositioningId = Empty is available since v7.8.
CreatePositioning(DocumentId)
Creates a positioning operation in a document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreatePositioning(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created positioning operation. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
DerivePartForModification(ElementId, Boolean)
Derives a part for modification in an assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
DocumentId DerivePartForModification(ElementId inOccurrenceId, bool inUseDefaultTemplate)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inOccurrenceId | Identifier of the occurrence of the part to derive in the assembly document. |
| System.Boolean | inUseDefaultTemplate | Tells whether to use the default template if present. |
Returns
| Type | Description |
|---|---|
| DocumentId | Derived part document identifier. |
Remarks
The occurrence of the part must be in the parts folder of the assembly, or at the first level of an assembly occurrence that is in the parts folder of the assembly (in which case a derived sub-assembly will also be created).
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
GetAssemblyCenterOfMassManagement(DocumentId)
Tells whether the physical property management of an assembly is center of mass managed.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
bool GetAssemblyCenterOfMassManagement(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The physical property management is center of mass managed. |
Remarks
This method is available since v7.13.300.220.
GetAssemblyMassManagement(DocumentId)
Tells whether the physical property management of an assembly is mass managed.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
bool GetAssemblyMassManagement(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The physical property management is mass managed. |
Remarks
This method is available since v7.13.300.220.
GetAssemblyMomentsOfInertiaManagement(DocumentId)
Tells whether the physical property management of an assembly is moments of inertia managed.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
bool GetAssemblyMomentsOfInertiaManagement(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The physical property management is moments of inertia managed. |
Remarks
This method is available since v7.13.300.220.
GetAssemblyStrictMode(DocumentId)
Tells whether the physical property management of an assembly is strict.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
bool GetAssemblyStrictMode(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The physical property management is strict. |
Remarks
This method is available since v7.13.300.220.
GetAssemblySurfaceAreaManagement(DocumentId)
Tells whether the physical property management of an assembly is surface area managed.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
bool GetAssemblySurfaceAreaManagement(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The physical property management is surface area managed. |
Remarks
This method is available since v7.13.300.220.
GetAssemblyVolumeManagement(DocumentId)
Tells whether the physical property management of an assembly is volume managed.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
bool GetAssemblyVolumeManagement(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The physical property management is volume managed. |
Remarks
This method is available since v7.13.300.220.
GetBom(DocumentId)
Gets BOM contents.
Declaration
[Obsolete("Since v7.12, access to BOM is done using IBoms interface.")]
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
BomRoot GetBom(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of BOM document to analyze. |
Returns
| Type | Description |
|---|---|
| BomRoot | BOM contents. |
Remarks
This method is available since v7.6.
GetCollisionsManagement(DocumentId, out ElementId, out Boolean, out Boolean, out Boolean)
Gets the collisions management of an assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
void GetCollisionsManagement(DocumentId inDocumentId, out ElementId outRepresentationId, out bool outFindsIntersections, out bool outExcludesThreadingTapping, out bool outIsRefreshAuto)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to analyze. |
| ElementId | outRepresentationId | Identifier of the analyzed representation entity, or empty if there is no collisions management. |
| System.Boolean | outFindsIntersections | Whether to find collisions intersections. |
| System.Boolean | outExcludesThreadingTapping | Whether to exclude threading-tapping collisions. |
| System.Boolean | outIsRefreshAuto | Whether refresh is automatic. |
Remarks
This method is available since v7.8.
GetDriversFromFamily(DocumentId, out String, out List<String>, out List<SmartObject>, out List<String>, out List<SmartDesignObject>)
Get code and drivers from a family document
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void GetDriversFromFamily(DocumentId inDocumentId, out string outCode, out List<string> outKernelDriverNames, out List<SmartObject> outKernelDriverValues, out List<string> outDesignDriverNames, out List<SmartDesignObject> outDesignDriverValues)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the family document. |
| System.String | outCode | Default code, or null if none. |
| System.Collections.Generic.List<System.String> | outKernelDriverNames | Generic document kernel driver names, or null if none. |
| System.Collections.Generic.List<SmartObject> | outKernelDriverValues | Generic document kernel driver values, or null if none. |
| System.Collections.Generic.List<System.String> | outDesignDriverNames | Generic document design driver names, or null if none. |
| System.Collections.Generic.List<SmartDesignObject> | outDesignDriverValues | Generic document design driver values, or null if none. |
Remarks
This method is available since v7.19.
GetDriverSubFolderName(ElementId, String)
Gets the name of the driver sub folder.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
string GetDriverSubFolderName(ElementId inElementId, string inDriverName)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the inclusion operation. |
| System.String | inDriverName | Instance driver names. |
Returns
| Type | Description |
|---|---|
| System.String | The name of the sub-folder. |
Remarks
This method is available since v7.17.
GetFunctionsInheritingOperation(ElementId, out ElementId, out List<ElementId>, out List<ElementId>)
Gets a functions inheriting operation.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
void GetFunctionsInheritingOperation(ElementId inOperationId, out ElementId outOccurrenceId, out List<ElementId> outFunctionIds, out List<ElementId> outChildIds)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inOperationId | Identifier of the functions inheriting operation to analyze. |
| ElementId | outOccurrenceId | Identifier of the occurrence of the part or assembly providing the functions to inherit. |
| System.Collections.Generic.List<ElementId> | outFunctionIds | Identifiers of the specified function entities to inherit from in the occurrence definition document. |
| System.Collections.Generic.List<ElementId> | outChildIds | Identifiers of the children provided functions. |
Remarks
This method is available since v7.8.
GetInclusionChildOccurrence(ElementId)
Gets the part or assembly occurrence entity generated by an inclusion operation.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
ElementId GetInclusionChildOccurrence(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the inclusion operation to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the part or assembly occurrence entity generated by the inclusion operation. |
Remarks
This method is available since v7.8.
GetInclusionCodeAndDrivers(ElementId, out String, out List<String>, out List<SmartObject>)
Gets the code and drivers of a family inclusion operation.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void GetInclusionCodeAndDrivers(ElementId inElementId, out string outCode, out List<string> outDriverNames, out List<SmartObject> outDriverValues)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the inclusion operation to analyze. |
| System.String | outCode | Instance code, or null if none. |
| System.Collections.Generic.List<System.String> | outDriverNames | Instance driver names, or null if none. |
| System.Collections.Generic.List<SmartObject> | outDriverValues | Instance driver values, or null if none. |
Remarks
This method is available since v7.10.
GetInclusionCodeAndDrivers2(ElementId, out String, out List<String>, out List<SmartObject>, out List<String>, out List<SmartDesignObject>)
Gets the code and drivers of a family inclusion operation.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
void GetInclusionCodeAndDrivers2(ElementId inElementId, out string outCode, out List<string> outKernelDriverNames, out List<SmartObject> outKernelDriverValues, out List<string> outDesignDriverNames, out List<SmartDesignObject> outDesignDriverValues)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the inclusion operation to analyze. |
| System.String | outCode | Instance code, or null if none. |
| System.Collections.Generic.List<System.String> | outKernelDriverNames | Instance kernel driver names, or null if none. |
| System.Collections.Generic.List<SmartObject> | outKernelDriverValues | Instance kernel driver values, or null if none. |
| System.Collections.Generic.List<System.String> | outDesignDriverNames | Instance design driver names, or null if none. |
| System.Collections.Generic.List<SmartDesignObject> | outDesignDriverValues | Instance design driver values, or null if none. |
Remarks
This method is available since v7.17.
GetInclusionDefinitionDocument(ElementId)
Gets the definition document of an inclusion operation.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
DocumentId GetInclusionDefinitionDocument(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the inclusion operation to analyze. |
Returns
| Type | Description |
|---|---|
| DocumentId | Identifier of the definition document of the inluded part or assembly. |
Remarks
This method is available since v7.8.
GetNodeBomIndex(ElementId)
Gets the bill of material index attached to a specified assembly node entity.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 12, 0, 0)]
string GetNodeBomIndex(ElementId inNodeId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inNodeId | Identifier of the assembly node entity (assembly or part occurrence, local part, ...) to analyze. |
Returns
| Type | Description |
|---|---|
| System.String | Bill of material index attached, or |
Remarks
This method is available since v7.12.
GetNodeProperties(ElementId, out List<PropertyDefinition>, out List<Property>)
Gets the properties attached to a specified assembly node entity.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 12, 0, 0)]
void GetNodeProperties(ElementId inNodeId, out List<PropertyDefinition> outDefinitions, out List<Property> outProperties)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inNodeId | Identifier of the assembly node entity (assembly or part occurrence, local part, ...) to analyze. |
| System.Collections.Generic.List<PropertyDefinition> | outDefinitions | Definitions of the properties attached to the specified node, or empty if none. |
| System.Collections.Generic.List<Property> | outProperties | Properties attached to the specified node, or empty if none. |
Remarks
This method is available since v7.12.
GetOccurrenceDefinition(ElementId)
Gets the definition document of a part or assembly occurrence entity.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
DocumentId GetOccurrenceDefinition(ElementId inOccurrenceId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inOccurrenceId | Identifier of the part or assembly occurrence to analyze. |
Returns
| Type | Description |
|---|---|
| DocumentId | Identifier of the definition document of the occurrence. |
Remarks
This method is available since v7.8.
GetOccurrencePublishing(ElementId, ElementId)
Gets the constituent of an occurrence corresponding to a specified publishing entity.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
ElementId GetOccurrencePublishing(ElementId inOccurrenceId, ElementId inPublishingId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inOccurrenceId | Identifier of the part or assembly occurrence to analyze. |
| ElementId | inPublishingId | Identifier of the specified publishing entity in the occurrence definition document. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the corresponding constituent entity of the occurrence. |
Remarks
This method is available since v7.8.
GetParts(DocumentId)
Gets the part or assembly entities that are in the parts folder of an asssembly document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
List<ElementId> GetParts(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the assembly document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ElementId> | Part or assembly entities found. |
Remarks
This method is available since v7.8.
HasDriverSubFolderOwner(ElementId, String)
Determines whether the driver is inside the sub-folder inside the driver folder of the family document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
bool HasDriverSubFolderOwner(ElementId inElementId, string inDriverName)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the inclusion operation. |
| System.String | inDriverName | Instance driver names. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The driver is inside a sub-folder. |
Remarks
This method is available since v7.17.
InheritOccurrenceFunctions(ElementId, List<ElementId>)
Provides functions by inheriting from the ones provided in a part or assembly occurrence.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
ElementId InheritOccurrenceFunctions(ElementId inOccurrenceId, List<ElementId> inFunctionIds)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inOccurrenceId | Identifier of the occurrence of the part or assembly providing the functions to inherit. |
| System.Collections.Generic.List<ElementId> | inFunctionIds | Identifiers of the specified function entities to inherit from in the occurrence definition document. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created functions inheriting operation. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.8.
IsAssembly(DocumentId)
Tells whether a document is an assembly document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
bool IsAssembly(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The document is an assembly document. |
Remarks
This method is available since v7.6.
IsAssemblyOccurrence(ElementId)
Tells whether an element is an assembly occurrence entity.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
bool IsAssemblyOccurrence(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the element to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The element is an assembly occurrence entity. |
Remarks
This method is available since v7.8.
IsCollisionsManagementCheckingMechanisms(DocumentId)
Tells whether the collisions management of an assembly is checking for collisions between rigid groups of articulated subassemblies.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
bool IsCollisionsManagementCheckingMechanisms(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Whether the collisions management of the assembly is checking for collisions between rigid groups of articulated subassemblies. |
Remarks
This method is available since v7.10.
IsInclusion(ElementId)
Tells whether an element is an inclusion operation.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
bool IsInclusion(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the element to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The element is an inclusion operation. |
Remarks
This method is available since v7.8.
IsLocalPartOrLocalAssembly(ElementId)
Tells whether an element is a local part or a local assembly entity.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
bool IsLocalPartOrLocalAssembly(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the element to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The element is a local part or a local assemby entity. |
Remarks
This method is available since v7.17.
IsPartOccurrence(ElementId)
Tells whether an element is a part occurrence entity.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
bool IsPartOccurrence(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the element to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The element is a part occurrence entity. |
Remarks
This method is available since v7.8.
IsWizardInclusion(ElementId)
Tells whether an element is a wizard operation.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool IsWizardInclusion(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the element to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The element is an inclusion operation. |
Remarks
This method is available since v7.19.
LinkBom(DocumentId, DocumentId, Boolean)
Make BOM.
Declaration
[Obsolete("Since v7.12, access to BOM is done using IBoms interface.")]
[OperationContract]
[AvailableSinceVersion(7, 11, 300, 9)]
void LinkBom(DocumentId inDocumentId, DocumentId inBomDocumentId, bool inGroupItemsByProperties)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the assembly document. |
| DocumentId | inBomDocumentId | Identifier of the bom document. |
| System.Boolean | inGroupItemsByProperties | regroup mode |
Remarks
This method is available since v7.11.300.9
RedirectInclusion(ElementId, DocumentId)
Redirects an inclusion operation.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 7, 201, 100)]
void RedirectInclusion(ElementId inElementId, DocumentId inDefinitionId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the inclusion operation to modify. |
| DocumentId | inDefinitionId | Identifier of the new definition document of the part or assembly to include. |
Remarks
The previous definition document must be a part or an assembly, not a family.
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.7.201.100.
RedirectInclusionWithCodeAndDrivers(ElementId, DocumentId, String, List<String>, List<SmartObject>)
Redirects an inclusion operation to a family with specified code and drivers.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 12, 300, 80)]
void RedirectInclusionWithCodeAndDrivers(ElementId inElementId, DocumentId inDefinitionId, string inCode, List<string> inDriverNames, List<SmartObject> inDriverValues)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the inclusion operation to modify. |
| DocumentId | inDefinitionId | Identifier of the new family definition document to include. |
| System.String | inCode | Instance code, or null if none. |
| System.Collections.Generic.List<System.String> | inDriverNames | Instance driver names, or null if none. |
| System.Collections.Generic.List<SmartObject> | inDriverValues | Instance driver values, or null if none. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.12.300.080.
RedirectInclusionWithCodeAndDrivers2(ElementId, DocumentId, String, List<String>, List<SmartObject>, List<String>, List<SmartDesignObject>)
Redirects an inclusion operation to a family with specified code and drivers.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 17, 300, 80)]
void RedirectInclusionWithCodeAndDrivers2(ElementId inElementId, DocumentId inDefinitionId, string inCode, List<string> inKernelDriverNames, List<SmartObject> inKernelDriverValues, List<string> inDesignDriversValues, List<SmartDesignObject> inDesignDriverValues)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the inclusion operation to modify. |
| DocumentId | inDefinitionId | Identifier of the new family definition document to include. |
| System.String | inCode | Instance code, or null if none. |
| System.Collections.Generic.List<System.String> | inKernelDriverNames | Instance kernel driver names, or null if none. |
| System.Collections.Generic.List<SmartObject> | inKernelDriverValues | Instance kernel driver values, or null if none. |
| System.Collections.Generic.List<System.String> | inDesignDriversValues | Instance design driver names, or null if none. |
| System.Collections.Generic.List<SmartDesignObject> | inDesignDriverValues | Instance design driver values, or null if none. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.17.
SetAssemblyCenterOfMassManagement(DocumentId, Boolean)
Sets the center of mass management of the physical property management of an assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void SetAssemblyCenterOfMassManagement(DocumentId inDocumentId, bool inIsCenterOfMassManaged)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to analyze. |
| System.Boolean | inIsCenterOfMassManaged | Tells whether the physical property management of an assembly is center of mass managed. |
Remarks
This method is available since v7.13.300.220.
SetAssemblyMassManagement(DocumentId, Boolean)
Sets the mass management of the physical property management of an assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void SetAssemblyMassManagement(DocumentId inDocumentId, bool inIsMassManaged)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to analyze. |
| System.Boolean | inIsMassManaged | Tells whether the physical property management of an assembly is mass managed. |
Remarks
This method is available since v7.13.300.220.
SetAssemblyMomentsOfInertiaManagement(DocumentId, Boolean)
Sets the moments of inertia management of the physical property management of an assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void SetAssemblyMomentsOfInertiaManagement(DocumentId inDocumentId, bool inIsInertiaManaged)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to analyze. |
| System.Boolean | inIsInertiaManaged | Tells whether the physical property management of an assembly is moments of inertia managed. |
Remarks
This method is available since v7.13.300.220.
SetAssemblyStrictMode(DocumentId, Boolean)
Sets the strict mode of the physical property management of an assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void SetAssemblyStrictMode(DocumentId inDocumentId, bool inIsStrict)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to analyze. |
| System.Boolean | inIsStrict | Tells whether the physical property management of an assembly is strict. |
Remarks
This method is available since v7.13.300.220.
SetAssemblySurfaceAreaManagement(DocumentId, Boolean)
Sets the surface area management of the physical property management of an assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void SetAssemblySurfaceAreaManagement(DocumentId inDocumentId, bool inIsSurfaceAreaManaged)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to analyze. |
| System.Boolean | inIsSurfaceAreaManaged | Tells whether the physical property management of an assembly is surface area managed. |
Remarks
This method is available since v7.13.300.220.
SetAssemblyVolumeManagement(DocumentId, Boolean)
Sets the volume management of the physical property management of an assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void SetAssemblyVolumeManagement(DocumentId inDocumentId, bool inIsVolumeManaged)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to analyze. |
| System.Boolean | inIsVolumeManaged | Tells whether the physical property management of an assembly is volume managed. |
Remarks
This method is available since v7.13.300.220.
SetCollisionsManagement(DocumentId, ElementId, Boolean, Boolean, Boolean)
Sets the collisions management of an assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
void SetCollisionsManagement(DocumentId inDocumentId, ElementId inRepresentationId, bool inFindsIntersections, bool inExcludesThreadingTapping, bool inIsRefreshAuto)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to modify. |
| ElementId | inRepresentationId | Identifier of the analyzed representation entity, or empty for no collisions management. |
| System.Boolean | inFindsIntersections | Whether to find collisions intersections. |
| System.Boolean | inExcludesThreadingTapping | Whether to exclude threading-tapping collisions. |
| System.Boolean | inIsRefreshAuto | Whether refresh is automatic. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.8.
SetCollisionsManagementCheckingMechanisms(DocumentId, Boolean)
Sets whether the collisions management of an assembly is checking for collisions between rigid groups of articulated subassemblies.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void SetCollisionsManagementCheckingMechanisms(DocumentId inDocumentId, bool inIsChecking)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of assembly document to modify. |
| System.Boolean | inIsChecking | Whether the collisions management of the assembly is checking for collisions between rigid groups of articulated subassemblies. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
SetInclusionCodeAndDrivers(ElementId, String, List<String>, List<SmartObject>)
Sets the code and drivers of a family inclusion operation.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void SetInclusionCodeAndDrivers(ElementId inElementId, string inCode, List<string> inDriverNames, List<SmartObject> inDriverValues)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the inclusion operation to modify. |
| System.String | inCode | Instance code, or null if none. |
| System.Collections.Generic.List<System.String> | inDriverNames | Instance driver names, or null if none. |
| System.Collections.Generic.List<SmartObject> | inDriverValues | Instance driver values, or null if none. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
SetInclusionCodeAndDrivers2(ElementId, String, List<String>, List<SmartObject>, List<String>, List<SmartDesignObject>)
Sets the code and drivers of a family inclusion operation.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
void SetInclusionCodeAndDrivers2(ElementId inElementId, string inCode, List<string> inKernelDriverNames, List<SmartObject> inKernelDriverValues, List<string> inDesignDriverNames, List<SmartDesignObject> inDesignDriverValues)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the inclusion operation to modify. |
| System.String | inCode | Instance code, or null if none. |
| System.Collections.Generic.List<System.String> | inKernelDriverNames | Instance kernel driver names, or null if none. |
| System.Collections.Generic.List<SmartObject> | inKernelDriverValues | Instance kernel driver values, or null if none. |
| System.Collections.Generic.List<System.String> | inDesignDriverNames | Instance kernel driver names, or null if none. |
| System.Collections.Generic.List<SmartDesignObject> | inDesignDriverValues | Instance kernel driver values, or null if none. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.17.
SetNodeBomIndex(ElementId, String)
Sets the bill of material index attached to a specified assembly node entity.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 12, 0, 0)]
void SetNodeBomIndex(ElementId inNodeId, string inBomIndex)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inNodeId | Identifier of the assembly node entity (assembly or part occurrence, local part, ...) to modify. |
| System.String | inBomIndex | Bill of material index to attach, or |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.12.
TransformInclusion(ElementId, Transform3D)
Transforms an inclusion operation.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 7, 201, 100)]
void TransformInclusion(ElementId inElementId, Transform3D inTransform)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the inclusion operation to modify. |
| Transform3D | inTransform | Transformation to apply. |
Remarks
The inclusion operation must be constituent of a positioning operation (this method may not be used on in-place parts inclusions).
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.7.201.100.