ToolPathSplitBuilder Class¶
-
class
NXOpen.CAM.
ToolPathSplitBuilder
¶ Bases:
NXOpen.Builder
Represents a Tool Path Split Builder
To create a new instance of this class, use
NXOpen.CAM.CAMSetup.CreateToolPathSplitBuilder()
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
HolderClearance | Returns the Holder Clearance |
NeckClearance | Returns the Neck Clearance |
OperationList | Returns the operation list |
ShankClearance | Returns the Shank Clearance |
SplitType | Returns or sets the type of split (by tranfer or collision) |
Tag | Returns the Tag for this object. |
ToolPathSplitParametersBuilder | Returns the tool path split parameters |
TransferHeight | Returns or sets the transfer height |
TransferType | Returns or sets the transfer type (direct, clearance, lowest safe z) |
TransferUsingMethod | Returns or sets the transfer using method (none, ramp on shape, lift and plunge) |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CreateToolPathSplitItemBuilder | The method to create the SplitToolPathItemBuilder @return |
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. |
Enumerations¶
ToolPathSplitBuilderSplitTypes Enumeration | Divide type options |
ToolPathSplitBuilderTransferTypes Enumeration | Transfer type options |
ToolPathSplitBuilderTransferUsingMethods Enumeration | Transfer using options |
Property Detail¶
HolderClearance¶
-
ToolPathSplitBuilder.
HolderClearance
¶ Returns the Holder Clearance
-------------------------------------
Getter Method
Signature
HolderClearance()
Returns: Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX9.0.0.
License requirements: None.
NeckClearance¶
-
ToolPathSplitBuilder.
NeckClearance
¶ Returns the Neck Clearance
-------------------------------------
Getter Method
Signature
NeckClearance()
Returns: Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX9.0.0.
License requirements: None.
OperationList¶
-
ToolPathSplitBuilder.
OperationList
¶ Returns the operation list
-------------------------------------
Getter Method
Signature
OperationList()
Returns: Return type: NXOpen.CAM.ToolPathSplitItemBuilderList
New in version NX9.0.0.
License requirements: None.
ShankClearance¶
-
ToolPathSplitBuilder.
ShankClearance
¶ Returns the Shank Clearance
-------------------------------------
Getter Method
Signature
ShankClearance()
Returns: Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX9.0.0.
License requirements: None.
SplitType¶
-
ToolPathSplitBuilder.
SplitType
¶ Returns or sets the type of split (by tranfer or collision)
-------------------------------------
Getter Method
Signature
SplitType()
Returns: Return type: NXOpen.CAM.ToolPathSplitBuilderSplitTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SplitType(splitTypeValue)
Parameters: splitTypeValue ( NXOpen.CAM.ToolPathSplitBuilderSplitTypes
) –New in version NX6.0.0.
License requirements: None.
ToolPathSplitParametersBuilder¶
-
ToolPathSplitBuilder.
ToolPathSplitParametersBuilder
¶ Returns the tool path split parameters
-------------------------------------
Getter Method
Signature
ToolPathSplitParametersBuilder()
Returns: Return type: NXOpen.CAM.ToolPathSplitParametersBuilder
New in version NX9.0.0.
License requirements: None.
TransferHeight¶
-
ToolPathSplitBuilder.
TransferHeight
¶ Returns or sets the transfer height
-------------------------------------
Getter Method
Signature
TransferHeight()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TransferHeight(transferHeight)
Parameters: transferHeight (float) – New in version NX6.0.0.
License requirements: None.
TransferType¶
-
ToolPathSplitBuilder.
TransferType
¶ Returns or sets the transfer type (direct, clearance, lowest safe z)
-------------------------------------
Getter Method
Signature
TransferType()
Returns: Return type: NXOpen.CAM.ToolPathSplitBuilderTransferTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TransferType(transferType)
Parameters: transferType ( NXOpen.CAM.ToolPathSplitBuilderTransferTypes
) –New in version NX6.0.0.
License requirements: None.
TransferUsingMethod¶
-
ToolPathSplitBuilder.
TransferUsingMethod
¶ Returns or sets the transfer using method (none, ramp on shape, lift and plunge)
-------------------------------------
Getter Method
Signature
TransferUsingMethod()
Returns: Return type: NXOpen.CAM.ToolPathSplitBuilderTransferUsingMethods
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TransferUsingMethod(transferUsingMethod)
Parameters: transferUsingMethod ( NXOpen.CAM.ToolPathSplitBuilderTransferUsingMethods
) –New in version NX6.0.0.
License requirements: None.
Method Detail¶
CreateToolPathSplitItemBuilder¶
-
ToolPathSplitBuilder.
CreateToolPathSplitItemBuilder
¶ The method to create the SplitToolPathItemBuilder
Signature
CreateToolPathSplitItemBuilder()
Returns: Return type: NXOpen.CAM.ToolPathSplitItemBuilder
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
Validate¶
-
ToolPathSplitBuilder.
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.