AlongMachineAxisMoveBuilder Class¶
-
class
NXOpen.CAM.AlongMachineAxisMoveBuilder¶ Bases:
NXOpen.CAM.MoveBuilderRepresents Along MCS Axis Move Builder
To create a new instance of this class, use
NXOpen.CAM.MoveCollection.CreateAlongMcsAxisMoveBuilder()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| AAxis | Returns or sets the A position |
| AOutput | Returns or sets the A output |
| BAxis | Returns or sets the B position |
| BOutput | Returns or sets the B output |
| CAxis | Returns or sets the C position |
| COutput | Returns or sets the C output |
| FeedRate | Returns or sets the feed rate |
| FeedType | Returns or sets the feed type |
| FeedUnit | Returns or sets the feed unit |
| MotionType | Returns or sets the motion type |
| NumberOfUserParameters | Returns the number of user parameters |
| ProtectedMove | Returns or sets the protected move status |
| SubopLabel | Returns or sets the subop label |
| Tag | Returns the Tag for this object. |
| XAxis | Returns or sets the X position |
| XOutput | Returns or sets the X output |
| YAxis | Returns or sets the Y position |
| YOutput | Returns or sets the Y output |
| ZAxis | Returns or sets the Z position |
| ZOutput | Returns or sets the Z output |
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. |
| GetUserParameter | Returns the custom parameter with the given name. |
| SetParent | Set parent |
| SetSibling | Set sibling |
| 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¶
AAxis¶
-
AlongMachineAxisMoveBuilder.AAxis¶ Returns or sets the A position
-------------------------------------Getter Method
Signature
AAxis()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AAxis(axisPosition)Parameters: axisPosition (float) – New in version NX5.0.0.
License requirements: None.
AOutput¶
-
AlongMachineAxisMoveBuilder.AOutput¶ Returns or sets the A output
-------------------------------------Getter Method
Signature
AOutput()Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AOutput(output)Parameters: output (bool) – New in version NX5.0.0.
License requirements: None.
BAxis¶
-
AlongMachineAxisMoveBuilder.BAxis¶ Returns or sets the B position
-------------------------------------Getter Method
Signature
BAxis()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BAxis(axisPosition)Parameters: axisPosition (float) – New in version NX5.0.0.
License requirements: None.
BOutput¶
-
AlongMachineAxisMoveBuilder.BOutput¶ Returns or sets the B output
-------------------------------------Getter Method
Signature
BOutput()Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BOutput(output)Parameters: output (bool) – New in version NX5.0.0.
License requirements: None.
CAxis¶
-
AlongMachineAxisMoveBuilder.CAxis¶ Returns or sets the C position
-------------------------------------Getter Method
Signature
CAxis()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CAxis(axisPosition)Parameters: axisPosition (float) – New in version NX5.0.0.
License requirements: None.
COutput¶
-
AlongMachineAxisMoveBuilder.COutput¶ Returns or sets the C output
-------------------------------------Getter Method
Signature
COutput()Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
COutput(output)Parameters: output (bool) – New in version NX5.0.0.
License requirements: None.
XAxis¶
-
AlongMachineAxisMoveBuilder.XAxis¶ Returns or sets the X position
-------------------------------------Getter Method
Signature
XAxis()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
XAxis(axisPosition)Parameters: axisPosition (float) – New in version NX5.0.0.
License requirements: None.
XOutput¶
-
AlongMachineAxisMoveBuilder.XOutput¶ Returns or sets the X output
-------------------------------------Getter Method
Signature
XOutput()Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
XOutput(output)Parameters: output (bool) – New in version NX5.0.0.
License requirements: None.
YAxis¶
-
AlongMachineAxisMoveBuilder.YAxis¶ Returns or sets the Y position
-------------------------------------Getter Method
Signature
YAxis()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
YAxis(axisPosition)Parameters: axisPosition (float) – New in version NX5.0.0.
License requirements: None.
YOutput¶
-
AlongMachineAxisMoveBuilder.YOutput¶ Returns or sets the Y output
-------------------------------------Getter Method
Signature
YOutput()Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
YOutput(output)Parameters: output (bool) – New in version NX5.0.0.
License requirements: None.
ZAxis¶
-
AlongMachineAxisMoveBuilder.ZAxis¶ Returns or sets the Z position
-------------------------------------Getter Method
Signature
ZAxis()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ZAxis(axisPosition)Parameters: axisPosition (float) – New in version NX5.0.0.
License requirements: None.
ZOutput¶
-
AlongMachineAxisMoveBuilder.ZOutput¶ Returns or sets the Z output
-------------------------------------Getter Method
Signature
ZOutput()Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ZOutput(output)Parameters: output (bool) – New in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
AlongMachineAxisMoveBuilder.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.