SubmechanismPositionerBuilder Class¶
-
class
NXOpen.Motion.SubmechanismPositionerBuilder¶ Bases:
NXOpen.BuilderRepresents a
Motion.SubmechanismPositionerbuilderTo create a new instance of this class, use
NXOpen.Motion.SubmechanismPositionerCollection.CreatePositionerBuilder()New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| ChildCsys | Returns the child coordinate system. |
| Name | Returns or sets the unique name assigned to the submechanism positioner |
| ParentCsys | Returns the parent coordinate system. |
| Submechanism | Returns the submechanism to position. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetObject | Returns the object currently being edited by this builder. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
ChildCsys¶
-
SubmechanismPositionerBuilder.ChildCsys¶ Returns the child coordinate system.
A coordinate system defined in the submechanism to position. During positioning, the submechanism containing the child coordinate system will move to overlap it with the parent coordinate system.
-------------------------------------Getter Method
Signature
ChildCsysReturns: Return type: NXOpen.SelectCoordinateSystemNew in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
Name¶
-
SubmechanismPositionerBuilder.Name¶ Returns or sets the unique name assigned to the submechanism positioner
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
NameParameters: name (str) – New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
ParentCsys¶
-
SubmechanismPositionerBuilder.ParentCsys¶ Returns the parent coordinate system.
A coordinate system defined in the motion assembly or in another submechanism different from the submechanism to position. The parent coordinate system will not move during the positioning.
-------------------------------------Getter Method
Signature
ParentCsysReturns: Return type: NXOpen.SelectCoordinateSystemNew in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
Submechanism¶
-
SubmechanismPositionerBuilder.Submechanism¶ Returns the submechanism to position.
The Submechanism positioner will create an associative positioning to for the submechanism. The associatvie positioning will move the sumbemchanism so that the child CSYS overlaps with the parent CSYS.
-------------------------------------Getter Method
Signature
SubmechanismReturns: Return type: NXOpen.Assemblies.SelectComponentNew in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
Method Detail¶
Validate¶
-
SubmechanismPositionerBuilder.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.