Interface IParts
Gives access to parts.
Namespace: TopSolid.Cad.Design.Automating
Assembly: TopSolid.Cad.Design.Automating.dll
Syntax
[ServiceContract]
[AvailableSinceVersion(7, 6, 0, 0)]
public interface IPartsRemarks
This interface is available since v7.6.
Methods
CreateDrillingOperation(DocumentId, SmartShape, SmartFrame3D, List<DrillingPrimitive>, Boolean)
Creates a drilling operation in a document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 14, 0, 0)]
void CreateDrillingOperation(DocumentId inDocumentId, SmartShape inShape, SmartFrame3D inFrame, List<DrillingPrimitive> inDrillingPrimitives, bool inIsInoperative)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| SmartShape | inShape | Identifier of the shape to drill. |
| SmartFrame3D | inFrame | Frame of the drilling. |
| System.Collections.Generic.List<DrillingPrimitive> | inDrillingPrimitives | Primitives of the drilling. |
| System.Boolean | inIsInoperative | Tells wether the operation is Inoperative |
Remarks
This method is available since v7.14.000.00.
CreateDrillingOperationWithProcess(DocumentId, SmartShape, SmartFrame3D, List<DrillingPrimitive>, Boolean, PdmObjectId, Int32)
Creates a drilling operation using a process in a document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 14, 180, 0)]
void CreateDrillingOperationWithProcess(DocumentId inDocumentId, SmartShape inShape, SmartFrame3D inFrame, List<DrillingPrimitive> inDrillingPrimitives, bool inIsInoperative, PdmObjectId inProcessObjectId, int inValue)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| SmartShape | inShape | Identifier of the shape to drill. |
| SmartFrame3D | inFrame | Frame of the drilling. |
| System.Collections.Generic.List<DrillingPrimitive> | inDrillingPrimitives | Primitives of the drilling. |
| System.Boolean | inIsInoperative | Tells wether the operation is Inoperative |
| PdmObjectId | inProcessObjectId | PDM object identifier of the machining process definition document of the face. |
| System.Int32 | inValue | Machining process enumeration value, if the face has a machining process. |
Remarks
This method is available since v7.14.180.00.
CreateMachiningProcessOperation(PdmObjectId, Int32, List<ElementItemId>)
Creates the faces machining process.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 0, 0)]
ElementId CreateMachiningProcessOperation(PdmObjectId inObjectId, int inValue, List<ElementItemId> inFaceIds)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM object identifier of the machining process definition document of the face. |
| System.Int32 | inValue | Machining process enumeration value, if the face has a machining process. |
| System.Collections.Generic.List<ElementItemId> | inFaceIds | Identifier of the face to set attribute. |
Returns
| Type | Description |
|---|---|
| ElementId |
Remarks
This method is available since v7.13.
CreateMachiningProcessOperationWithDrivers(PdmObjectId, Int32, List<ElementItemId>, List<String>, List<SmartObject>, List<ElementItemId>, List<SmartPoint3D>, List<ElementId>)
Creates the machining process with driver values.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
ElementId CreateMachiningProcessOperationWithDrivers(PdmObjectId inObjectId, int inValue, List<ElementItemId> inFaceIds, List<string> inDriverDesignations, List<SmartObject> inDriverValues, List<ElementItemId> inFaceIdValues, List<SmartPoint3D> inPointValues, List<ElementId> inToleranceValues)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM object identifier of the machining process definition document of the face. |
| System.Int32 | inValue | Machining process enumeration value, if the face has a machining process. |
| System.Collections.Generic.List<ElementItemId> | inFaceIds | Identifier of the face to set attribute. |
| System.Collections.Generic.List<System.String> | inDriverDesignations | Driver designations. |
| System.Collections.Generic.List<SmartObject> | inDriverValues | Smart Object Driver values. |
| System.Collections.Generic.List<ElementItemId> | inFaceIdValues | Face ids |
| System.Collections.Generic.List<SmartPoint3D> | inPointValues | Smart Points values. |
| System.Collections.Generic.List<ElementId> | inToleranceValues | Tolerance drivers values. |
Returns
| Type | Description |
|---|---|
| ElementId |
Remarks
This method is available since v7.19.
GetCenterOfMassPropertyManagement(DocumentId, out Boolean, out SmartPoint3D)
Gets the center of mass property management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void GetCenterOfMassPropertyManagement(DocumentId inDocumentId, out bool outIsCenterOfMassManaged, out SmartPoint3D outManualCenterOfMass)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| System.Boolean | outIsCenterOfMassManaged | Whether the center of mass is managed. True for automatic or manual, false for not managed. |
| SmartPoint3D | outManualCenterOfMass | Manual center of mass, or null if no manual center of mass. |
Remarks
This method is available since v7.13.300.220.
GetCoating(DocumentId)
Gets the coating of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 301, 40)]
DocumentId GetCoating(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the part document to analyze. |
Returns
| Type | Description |
|---|---|
| DocumentId | Coating document identifier, or empty if the part does not have a coating. |
Remarks
This method is available since v7.6.301.40.
GetEnclosingBoxFrame(DocumentId)
Gets the enclosing box frame entity of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
ElementId GetEnclosingBoxFrame(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the enclosing box frame entity found, or empty if not managed. |
Remarks
This method is available since v7.10.
GetEnclosingBoxManagement(DocumentId, out EnclosingBoxManagementType, out SmartFrame3D, out SmartFrame3D, out SmartReal, out SmartReal, out SmartReal)
Gets the enclosing box management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void GetEnclosingBoxManagement(DocumentId inDocumentId, out EnclosingBoxManagementType outType, out SmartFrame3D outAlignmentFrame, out SmartFrame3D outBoxFrame, out SmartReal outBoxXSize, out SmartReal outBoxYSize, out SmartReal outBoxZSize)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| EnclosingBoxManagementType | outType | Type of management. |
| SmartFrame3D | outAlignmentFrame | Alignment frame, or null if not of type Aligned. |
| SmartFrame3D | outBoxFrame | Enclosing box frame, or null if not of type Manual. |
| SmartReal | outBoxXSize | Enclosing box size in X direction, or null if not of type Manual. |
| SmartReal | outBoxYSize | Enclosing box size in Y direction, or null if not of type Manual. |
| SmartReal | outBoxZSize | Enclosing box size in Z direction, or null if not of type Manual. |
Remarks
This method is available since v7.10.
GetEnclosingBoxParameters(DocumentId, out ElementId, out ElementId, out ElementId)
Gets the enclosing box parameters of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void GetEnclosingBoxParameters(DocumentId inDocumentId, out ElementId outBoxXSize, out ElementId outBoxYSize, out ElementId outBoxZSize)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| ElementId | outBoxXSize | Enclosing box size in X direction real parameter entity identifier, or empty if not managed. |
| ElementId | outBoxYSize | Enclosing box size in Y direction real parameter entity identifier, or empty if not managed. |
| ElementId | outBoxZSize | Enclosing box size in Z direction real parameter entity identifier, or empty if not managed. |
Remarks
This method is available since v7.10.
GetEnclosingCylinderAxis(DocumentId)
Gets the enclosing cylinder axis entity of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
ElementId GetEnclosingCylinderAxis(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the enclosing cylinder axis entity found, or empty if not managed. |
Remarks
This method is available since v7.10.
GetEnclosingCylinderCenterPoint(DocumentId)
Gets the enclosing cylinder center point entity of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
ElementId GetEnclosingCylinderCenterPoint(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the enclosing cylinder center point entity found, or empty if not managed. |
Remarks
This method is available since v7.10.
GetEnclosingCylinderManagement(DocumentId, out EnclosingCylinderManagementType, out SmartAxis3D, out SmartPoint3D, out SmartReal, out SmartReal)
Gets the enclosing cylinder management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void GetEnclosingCylinderManagement(DocumentId inDocumentId, out EnclosingCylinderManagementType outType, out SmartAxis3D outCylinderAxis, out SmartPoint3D outCenteringPoint, out SmartReal outCylinderDiameter, out SmartReal outCylinderLength)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| EnclosingCylinderManagementType | outType | Type of management. |
| SmartAxis3D | outCylinderAxis | Enclosing cylinder axis, or null if not of type Axial or Manual. |
| SmartPoint3D | outCenteringPoint | Centering point defining the enclosing cylinder center once projected on its axis, or null if not of type Manual. |
| SmartReal | outCylinderDiameter | Enclosing cylinder diameter, or null if not of type Manual. |
| SmartReal | outCylinderLength | Enclosing cylinder length, or null if not of type Manual. |
Remarks
This method is available since v7.10.
GetEnclosingCylinderParameters(DocumentId, out ElementId, out ElementId)
Gets the enclosing cylinder parameters of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void GetEnclosingCylinderParameters(DocumentId inDocumentId, out ElementId outCylinderDiameter, out ElementId outCylinderLength)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| ElementId | outCylinderDiameter | Enclosing cylinder diameter real parameter entity identifier, or empty if not managed. |
| ElementId | outCylinderLength | Enclosing cylinder length real parameter entity identifier, or empty if not managed. |
Remarks
This method is available since v7.10.
GetFinishing(DocumentId)
Gets the finishing of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 12, 0, 0)]
DocumentId GetFinishing(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the part document to analyze. |
Returns
| Type | Description |
|---|---|
| DocumentId | Finishing document identifier, or empty if the part does not have a finishing. |
Remarks
This method is available since v7.12.
GetInertiaPropertyManagement(DocumentId, out Boolean, out SmartFrame3D, out SmartReal, out SmartReal, out SmartReal)
Gets the moments of inertia property management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void GetInertiaPropertyManagement(DocumentId inDocumentId, out bool outIsInertiaManaged, out SmartFrame3D outManualFrame, out SmartReal outManualXMoment, out SmartReal outManualYMoment, out SmartReal outManualZMoment)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| System.Boolean | outIsInertiaManaged | Whether the moments of inertia is managed. True for automatic or manual, false for not managed. |
| SmartFrame3D | outManualFrame | Manual frame of moments of inertia, or null if no manual frame of moments of inertia. |
| SmartReal | outManualXMoment | Manual X moment of inertia, or null if no manual X moment of inertia. |
| SmartReal | outManualYMoment | Manual Y moment of inertia, or null if no manual Y moment of inertia. |
| SmartReal | outManualZMoment | Manual Z moment of inertia, or null if no manual Z moment of inertia. |
Remarks
This method is available since v7.13.300.220.
GetMachiningProcessOperationDrivers(ElementId, out List<KeyValuePair<String, MachiningDriverType>>, out List<SmartObject>, out List<ElementItemId>, out List<SmartPoint3D>, out List<ElementId>)
Gets the machining process driver values.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void GetMachiningProcessOperationDrivers(ElementId inElementId, out List<KeyValuePair<string, MachiningDriverType>> outDriverDesignationsWithTypes, out List<SmartObject> outDriverValues, out List<ElementItemId> outFaceIdValues, out List<SmartPoint3D> outPointValues, out List<ElementId> outToleranceValues)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Existing machining Process Operation |
| System.Collections.Generic.List<KeyValuePair<System.String, MachiningDriverType>> | outDriverDesignationsWithTypes | Driver designations with their types. |
| System.Collections.Generic.List<SmartObject> | outDriverValues | Smart Object Driver values. |
| System.Collections.Generic.List<ElementItemId> | outFaceIdValues | Face ids |
| System.Collections.Generic.List<SmartPoint3D> | outPointValues | Smart Points values. |
| System.Collections.Generic.List<ElementId> | outToleranceValues | Tolerance drivers values. |
Remarks
This method is available since v7.19.
GetMachiningProcessOperationFaces(ElementId, out List<ElementItemId>)
Gets Faces from a machining process operation
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void GetMachiningProcessOperationFaces(ElementId inElementId, out List<ElementItemId> outFaceIds)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Existing machining Process Operation |
| System.Collections.Generic.List<ElementItemId> | outFaceIds | Face Ids |
Remarks
This method is available since v7.19.
GetMassPropertyManagement(DocumentId, out Boolean, out SmartReal)
Gets the mass property management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void GetMassPropertyManagement(DocumentId inDocumentId, out bool outIsMassManaged, out SmartReal outManualMass)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| System.Boolean | outIsMassManaged | Whether the mass is managed. True for automatic or manual, false for not managed. |
| SmartReal | outManualMass | Manual mass, or null if no manual mass. |
Remarks
This method is available since v7.13.300.220.
GetMaterial(DocumentId)
Gets the material of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 301, 40)]
DocumentId GetMaterial(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the part document to analyze. |
Returns
| Type | Description |
|---|---|
| DocumentId | Material document identifier, or empty if the material of the part is not defined. |
Remarks
This method is available since v7.6.301.40.
GetSurfaceAreaPropertyManagement(DocumentId, out Boolean, out SmartReal)
Gets the surface area property management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void GetSurfaceAreaPropertyManagement(DocumentId inDocumentId, out bool outIsSurfaceManaged, out SmartReal outManualSurfaceArea)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| System.Boolean | outIsSurfaceManaged | Whether the surface area is managed. True for automatic or manual, false for not managed. |
| SmartReal | outManualSurfaceArea | Manual surface area, or null if no manual surface area. |
Remarks
This method is available since v7.13.300.220.
GetVolumePropertyManagement(DocumentId, out Boolean, out SmartReal)
Gets the volume property management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void GetVolumePropertyManagement(DocumentId inDocumentId, out bool outIsVolumeManaged, out SmartReal outManualVolume)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| System.Boolean | outIsVolumeManaged | Whether the volume is managed. True for automatic or manual, false for not managed. |
| SmartReal | outManualVolume | Manual volume, or null if no manual volume. |
Remarks
This method is available since v7.13.300.220.
IsCoatingDerived(DocumentId)
Tells whether the coating of a derived part is derived from the base part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 301, 40)]
bool IsCoatingDerived(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the part document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The coating of the derived part is derived from the base part. |
Remarks
This method is available since v7.6.301.40.
IsDerivedPart(DocumentId)
Tells whether a document is a derived part document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 301, 40)]
bool IsDerivedPart(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The document is a derived part document. |
Remarks
This method is available since v7.6.301.40.
IsFinishingDerived(DocumentId)
Tells whether the finishing of a derived part is derived from the base part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 12, 0, 0)]
bool IsFinishingDerived(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the part document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The finishing of the derived part is derived from the base part. |
Remarks
This method is available since v7.12.
IsMachiningProcessOperation(ElementId)
Tells whether element is a machining process operation
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool IsMachiningProcessOperation(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Existing machining Process Operation |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if element is a machining process operation. |
Remarks
This method is available since v7.19.
IsMaterialDerived(DocumentId)
Tells whether the material of a derived part is derived from the base part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 301, 40)]
bool IsMaterialDerived(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the part document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The material of the derived part is derived from the base part. |
Remarks
This method is available since v7.6.301.40.
IsPart(DocumentId)
Tells whether a document is a part document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
bool IsPart(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The document is a part document. |
Remarks
This method is available since v7.6.
IsPhysicalPropertiesManagementRefreshAuto(DocumentId)
Tells whether the physical property management of a part is refresh auto.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
bool IsPhysicalPropertiesManagementRefreshAuto(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The physical property management is refresh auto. |
Remarks
This method is available since v7.13.300.220.
ResetMachiningProcessOperationDriverValues(ElementId)
Clears all machining process drivers value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void ResetMachiningProcessOperationDriverValues(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Existing machining Process Operation |
Remarks
This method is available since v7.19.
SetCenterOfMassPropertyManagement(DocumentId, Boolean, SmartPoint3D)
Sets the center of mass property management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void SetCenterOfMassPropertyManagement(DocumentId inDocumentId, bool inIsCenterOfMassManaged, SmartPoint3D inManualCenterOfMass)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| System.Boolean | inIsCenterOfMassManaged | Whether the center of mass is managed. True for automatic or manual, false for not managed. |
| SmartPoint3D | inManualCenterOfMass | Manual center of mass, or null if no manual center of mass. |
Remarks
This method is available since v7.13.300.220.
SetCoating(DocumentId, DocumentId)
Sets the coating of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 301, 40)]
void SetCoating(DocumentId inDocumentId, DocumentId inCoatingDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the part document to modify. |
| DocumentId | inCoatingDocumentId | Coating document identifier, or empty if the part does not have a coating. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.301.40.
SetEnclosingBoxManagement(DocumentId, EnclosingBoxManagementType, SmartFrame3D, SmartFrame3D, SmartReal, SmartReal, SmartReal)
Sets the enclosing box management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void SetEnclosingBoxManagement(DocumentId inDocumentId, EnclosingBoxManagementType inType, SmartFrame3D inAlignmentFrame, SmartFrame3D inBoxFrame, SmartReal inBoxXSize, SmartReal inBoxYSize, SmartReal inBoxZSize)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to modify. |
| EnclosingBoxManagementType | inType | Type of management. |
| SmartFrame3D | inAlignmentFrame | Alignment frame, or null if not of type Aligned. |
| SmartFrame3D | inBoxFrame | Enclosing box frame, or null if not of type Manual. |
| SmartReal | inBoxXSize | Enclosing box size in X direction, or null if not of type Manual. |
| SmartReal | inBoxYSize | Enclosing box size in Y direction, or null if not of type Manual. |
| SmartReal | inBoxZSize | Enclosing box size in Z direction, or null if not of type Manual. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
SetEnclosingCylinderManagement(DocumentId, EnclosingCylinderManagementType, SmartAxis3D, SmartPoint3D, SmartReal, SmartReal)
Sets the enclosing cylinder management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void SetEnclosingCylinderManagement(DocumentId inDocumentId, EnclosingCylinderManagementType inType, SmartAxis3D inCylinderAxis, SmartPoint3D inCenteringPoint, SmartReal inCylinderDiameter, SmartReal inCylinderLength)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to modify. |
| EnclosingCylinderManagementType | inType | Type of management. |
| SmartAxis3D | inCylinderAxis | Enclosing cylinder axis, or null if not of type Axial or Manual. |
| SmartPoint3D | inCenteringPoint | Centering point defining the enclosing cylinder center once projected on its axis, or null if not of type Manual. |
| SmartReal | inCylinderDiameter | Enclosing cylinder diameter, or null if not of type Manual. |
| SmartReal | inCylinderLength | Enclosing cylinder length, or null if not of type Manual. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
SetFinishing(DocumentId, DocumentId)
Sets the finishing of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 12, 0, 0)]
void SetFinishing(DocumentId inDocumentId, DocumentId inFinishingDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the part document to modify. |
| DocumentId | inFinishingDocumentId | Finishing document identifier, or empty if the part does not have a finishing. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.12.
SetInertiaPropertyManagement(DocumentId, Boolean, SmartFrame3D, SmartReal, SmartReal, SmartReal)
Sets the moments of inertia property management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void SetInertiaPropertyManagement(DocumentId inDocumentId, bool inIsInertiaManaged, SmartFrame3D inManualFrame, SmartReal inManualXMoment, SmartReal inManualYMoment, SmartReal inManualZMoment)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| System.Boolean | inIsInertiaManaged | Whether the moments of inertia is managed. True for automatic or manual, false for not managed. |
| SmartFrame3D | inManualFrame | Manual frame of moments of inertia, or null if no manual frame of moments of inertia. |
| SmartReal | inManualXMoment | Manual X moment of inertia, or null if no manual X moment of inertia. |
| SmartReal | inManualYMoment | Manual Y moment of inertia, or null if no manual Y moment of inertia. |
| SmartReal | inManualZMoment | Manual Z moment of inertia, or null if no manual Z moment of inertia. |
Remarks
This method is available since v7.13.300.220.
SetMachiningProcessOperationDrivers(ElementId, List<String>, List<SmartObject>, List<ElementItemId>, List<SmartPoint3D>, List<ElementId>)
Sets the machining process with driver values.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void SetMachiningProcessOperationDrivers(ElementId inElementId, List<string> inDriverDesignations, List<SmartObject> inDriverValues, List<ElementItemId> inFaceIdValues, List<SmartPoint3D> inPointValues, List<ElementId> inToleranceValues)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Existing machining Process Operation to modify |
| System.Collections.Generic.List<System.String> | inDriverDesignations | Driver designations. |
| System.Collections.Generic.List<SmartObject> | inDriverValues | Smart Object Driver values. |
| System.Collections.Generic.List<ElementItemId> | inFaceIdValues | Face ids |
| System.Collections.Generic.List<SmartPoint3D> | inPointValues | Smart Points values. |
| System.Collections.Generic.List<ElementId> | inToleranceValues | Tolerance drivers values. |
Remarks
This method is available since v7.19.
SetMachiningProcessOperationEntryPoints(ElementId, SmartReal, SmartDirection3D, List<SmartPoint3D>)
Set Entry Points of a machining process operation
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void SetMachiningProcessOperationEntryPoints(ElementId inElementId, SmartReal inDiameter, SmartDirection3D inDirection, List<SmartPoint3D> inPoints)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Existing machining Process Operation |
| SmartReal | inDiameter | Diameter |
| SmartDirection3D | inDirection | Direction |
| System.Collections.Generic.List<SmartPoint3D> | inPoints | Entry points |
Remarks
This method is available since v7.19.
SetMachiningProcessOperationFaceDriverValue(ElementId, String, ElementItemId)
Sets a machining process face driver value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void SetMachiningProcessOperationFaceDriverValue(ElementId inElementId, string inDesignation, ElementItemId inFaceIdValue)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Existing machining Process Operation |
| System.String | inDesignation | Driver designations |
| ElementItemId | inFaceIdValue | Face ids |
Remarks
This method is available since v7.19.
SetMachiningProcessOperationFaces(ElementId, List<ElementItemId>)
Set Faces to a machining process operation
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void SetMachiningProcessOperationFaces(ElementId inElementId, List<ElementItemId> inFaceIds)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Existing machining Process Operation |
| System.Collections.Generic.List<ElementItemId> | inFaceIds | Face Ids |
Remarks
This method is available since v7.19.
SetMachiningProcessOperationPointDriverValue(ElementId, String, SmartPoint3D)
Sets a machining process point driver value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void SetMachiningProcessOperationPointDriverValue(ElementId inElementId, string inDesignation, SmartPoint3D inSmartPoint3D)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Existing machining Process Operation |
| System.String | inDesignation | Driver designations |
| SmartPoint3D | inSmartPoint3D | Smart 3DPoint |
Remarks
This method is available since v7.19.
SetMachiningProcessOperationSmartDriverValue(ElementId, String, SmartObject)
Sets a machining process smart driver value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void SetMachiningProcessOperationSmartDriverValue(ElementId inElementId, string inDesignation, SmartObject inDriverValue)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Existing machining Process Operation |
| System.String | inDesignation | Driver designations |
| SmartObject | inDriverValue | Driver value |
Remarks
This method is available since v7.19.
SetMachiningProcessOperationToleranceDriverValue(ElementId, String, ElementId)
Sets a machining process point driver value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void SetMachiningProcessOperationToleranceDriverValue(ElementId inElementId, string inDesignation, ElementId inTolerance)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Existing machining Process Operation |
| System.String | inDesignation | Driver designations |
| ElementId | inTolerance | Tolerance |
Remarks
This method is available since v7.19.
SetMassPropertyManagement(DocumentId, Boolean, SmartReal)
Sets the mass property management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void SetMassPropertyManagement(DocumentId inDocumentId, bool inIsMassManaged, SmartReal inManualMass)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| System.Boolean | inIsMassManaged | Whether the mass is managed. True for automatic or manual, false for not managed. |
| SmartReal | inManualMass | Manual mass, or null if no manual mass. |
Remarks
This method is available since v7.13.300.220.
SetMaterial(DocumentId, DocumentId)
Sets the material of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 301, 40)]
void SetMaterial(DocumentId inDocumentId, DocumentId inMaterialDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the part document to modify. |
| DocumentId | inMaterialDocumentId | Material document identifier, or empty if the material of the part is not defined. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.301.40.
SetPhysicalPropertiesManagementRefreshAuto(DocumentId, Boolean)
Sets the refresh auto of the physical property management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void SetPhysicalPropertiesManagementRefreshAuto(DocumentId inDocumentId, bool inIsRefreshAuto)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| System.Boolean | inIsRefreshAuto | Tells whether the physical property management of a part is refresh auto. |
Remarks
This method is available since v7.13.300.220.
SetSurfaceAreaPropertyManagement(DocumentId, Boolean, SmartReal)
Sets the surface area property management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void SetSurfaceAreaPropertyManagement(DocumentId inDocumentId, bool inIsSurfaceManaged, SmartReal inManualSurfaceArea)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| System.Boolean | inIsSurfaceManaged | Whether the surface area is managed. True for automatic or manual, false for not managed. |
| SmartReal | inManualSurfaceArea | Manual surface area, or null if no manual surface area. |
Remarks
This method is available since v7.13.300.220.
SetVolumePropertyManagement(DocumentId, Boolean, SmartReal)
Sets the volume property management of a part.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 300, 220)]
void SetVolumePropertyManagement(DocumentId inDocumentId, bool inIsVolumeManaged, SmartReal inManualVolume)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part document to analyze. |
| System.Boolean | inIsVolumeManaged | Whether the volume is managed. True for automatic or manual, false for not managed. |
| SmartReal | inManualVolume | Manual volume, or null if no manual volume. |
Remarks
This method is available since v7.13.300.220.