RotateToolMoveBuilder Class¶
-
class
NXOpen.CAM.
RotateToolMoveBuilder
¶ Bases:
NXOpen.CAM.MoveBuilder
Represents the Rotate Tool Move Builder
To create a new instance of this class, use
NXOpen.CAM.MoveCollection.CreateRotateToolMoveBuilder
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
Adjreg | Returns or sets the Adjust register |
AdjregToggle | Returns or sets the Adjust register Toggle Status |
Angle | Returns or sets the Orient Angle |
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. |
Xoffset | Returns or sets the X offset |
XoffsetToggle | Returns or sets the X offset Toggle Status |
Yoffset | Returns or sets the Y offset |
YoffsetToggle | Returns or sets the Y offset Toggle Status |
Zoffset | Returns or sets the Z offset |
ZoffsetToggle | Returns or sets the Z offset Toggle Status |
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¶
Adjreg¶
-
RotateToolMoveBuilder.
Adjreg
¶ Returns or sets the Adjust register
-------------------------------------
Getter Method
Signature
Adjreg()
Returns: Return type: int New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Adjreg(adjreg)
Parameters: adjreg (int) – New in version NX5.0.0.
License requirements: None.
AdjregToggle¶
-
RotateToolMoveBuilder.
AdjregToggle
¶ Returns or sets the Adjust register Toggle Status
-------------------------------------
Getter Method
Signature
AdjregToggle()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AdjregToggle(adjregstat)
Parameters: adjregstat (bool) – New in version NX5.0.0.
License requirements: None.
Angle¶
-
RotateToolMoveBuilder.
Angle
¶ Returns or sets the Orient Angle
-------------------------------------
Getter Method
Signature
Angle()
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Angle(angle)
Parameters: angle (float) – New in version NX5.0.0.
License requirements: None.
Xoffset¶
-
RotateToolMoveBuilder.
Xoffset
¶ Returns or sets the X offset
-------------------------------------
Getter Method
Signature
Xoffset()
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Xoffset(xoff)
Parameters: xoff (float) – New in version NX5.0.0.
License requirements: None.
XoffsetToggle¶
-
RotateToolMoveBuilder.
XoffsetToggle
¶ Returns or sets the X offset Toggle Status
-------------------------------------
Getter Method
Signature
XoffsetToggle()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
XoffsetToggle(xoffstat)
Parameters: xoffstat (bool) – New in version NX5.0.0.
License requirements: None.
Yoffset¶
-
RotateToolMoveBuilder.
Yoffset
¶ Returns or sets the Y offset
-------------------------------------
Getter Method
Signature
Yoffset()
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Yoffset(yoff)
Parameters: yoff (float) – New in version NX5.0.0.
License requirements: None.
YoffsetToggle¶
-
RotateToolMoveBuilder.
YoffsetToggle
¶ Returns or sets the Y offset Toggle Status
-------------------------------------
Getter Method
Signature
YoffsetToggle()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
YoffsetToggle(yoffstat)
Parameters: yoffstat (bool) – New in version NX5.0.0.
License requirements: None.
Zoffset¶
-
RotateToolMoveBuilder.
Zoffset
¶ Returns or sets the Z offset
-------------------------------------
Getter Method
Signature
Zoffset()
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Zoffset(zoff)
Parameters: zoff (float) – New in version NX5.0.0.
License requirements: None.
ZoffsetToggle¶
-
RotateToolMoveBuilder.
ZoffsetToggle
¶ Returns or sets the Z offset Toggle Status
-------------------------------------
Getter Method
Signature
ZoffsetToggle()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ZoffsetToggle(zoffstat)
Parameters: zoffstat (bool) – New in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
RotateToolMoveBuilder.
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.