MoveBuilder Class¶
-
class
NXOpen.CAM.
MoveBuilder
¶ Bases:
NXOpen.Builder
Represents Move Builder
This cannot be instantiated
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
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. |
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. |
Enumerations¶
MoveBuilderFeed Enumeration | the feed Type |
MoveBuilderMotion Enumeration | the motion Type |
Property Detail¶
FeedRate¶
-
MoveBuilder.
FeedRate
¶ Returns or sets the feed rate
-------------------------------------
Getter Method
Signature
FeedRate()
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FeedRate(feedRate)
Parameters: feedRate (float) – New in version NX5.0.0.
License requirements: None.
FeedType¶
-
MoveBuilder.
FeedType
¶ Returns or sets the feed type
-------------------------------------
Getter Method
Signature
FeedType()
Returns: Return type: NXOpen.CAM.MoveBuilderFeed
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FeedType(feedType)
Parameters: feedType ( NXOpen.CAM.MoveBuilderFeed
) –New in version NX5.0.0.
License requirements: None.
FeedUnit¶
-
MoveBuilder.
FeedUnit
¶ Returns or sets the feed unit
-------------------------------------
Getter Method
Signature
FeedUnit()
Returns: the current unit Return type: NXOpen.CAM.FeedRateUnit
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FeedUnit(unit)
Parameters: unit ( NXOpen.CAM.FeedRateUnit
) – the new unitNew in version NX7.5.0.
License requirements: None.
MotionType¶
-
MoveBuilder.
MotionType
¶ Returns or sets the motion type
-------------------------------------
Getter Method
Signature
MotionType()
Returns: Return type: NXOpen.CAM.MoveBuilderMotion
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MotionType(motionType)
Parameters: motionType ( NXOpen.CAM.MoveBuilderMotion
) –New in version NX5.0.0.
License requirements: None.
NumberOfUserParameters¶
-
MoveBuilder.
NumberOfUserParameters
¶ Returns the number of user parameters
-------------------------------------
Getter Method
Signature
NumberOfUserParameters()
Returns: the number of parameters Return type: int New in version NX8.0.0.
License requirements: None.
ProtectedMove¶
-
MoveBuilder.
ProtectedMove
¶ Returns or sets the protected move status
-------------------------------------
Getter Method
Signature
ProtectedMove()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ProtectedMove(protectedMove)
Parameters: protectedMove (bool) – New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
SubopLabel¶
-
MoveBuilder.
SubopLabel
¶ Returns or sets the subop label
-------------------------------------
Getter Method
Signature
SubopLabel()
Returns: Return type: str New in version NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
SubopLabel(subopLabel)
Parameters: subopLabel (str) – New in version NX8.5.1.
License requirements: None.
Method Detail¶
GetUserParameter¶
-
MoveBuilder.
GetUserParameter
¶ Overloaded method GetUserParameter
GetUserParameter(parameterName)
GetUserParameter(index)
-------------------------------------
Returns the custom parameter with the given name.
Signature
GetUserParameter(parameterName)
Parameters: parameterName (str) – the parameter name Returns: the parameter Return type: NXOpen.CAM.UdeParameter
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Returns the parameter at the input index.
Signature
GetUserParameter(index)
Parameters: index (int) – the parameter index Returns: the parameter Return type: NXOpen.CAM.UdeParameter
New in version NX8.0.0.
License requirements: None.
-------------------------------------
SetParent¶
-
MoveBuilder.
SetParent
¶ Set parent
Signature
SetParent(parent)
Parameters: parent ( NXOpen.CAM.CAMObject
) – the parent objectNew in version NX5.0.0.
License requirements: None.
SetSibling¶
-
MoveBuilder.
SetSibling
¶ Set sibling
Signature
SetSibling(sibling)
Parameters: sibling ( NXOpen.CAM.CAMObject
) – the sibling objectNew in version NX5.0.0.
License requirements: None.
Validate¶
-
MoveBuilder.
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.