ToolPathSplitParametersBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ToolPathSplitParametersBuilder Class

class `NXOpen.CAM.``ToolPathSplitParametersBuilder`

  Bases: `NXOpen.Builder`

  Represents the Divide Parameters

  This object is owned by another builder.

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
MinimumCutLength | Returns the minimum cut length builder
OverlapDistance | Returns the overlap distance builder
SplitType | Returns or sets the type of split (by tranfer or collision)
Tag | Returns the Tag for this object.
TransferHeight | Returns or sets the transfer height
TransferHeightBuilder | Returns the transfer height builder
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)
TrimmingSteepAngle | Returns or sets the trimming steep angle

# 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.

# Enumerations

ToolPathSplitParametersBuilderSplitTypes Enumeration | Divide type options
ToolPathSplitParametersBuilderTransferTypes Enumeration | Transfer type options
ToolPathSplitParametersBuilderTransferUsingMethods Enumeration | Transfer using options

# Property Detail

## MinimumCutLength

`ToolPathSplitParametersBuilder.``MinimumCutLength`

  Returns the minimum cut length builder

  `-------------------------------------`

  Getter Method

  Signature `MinimumCutLength`

  Returns: | the minimum cut length builder
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX6.0.0.

  License requirements: None.

## OverlapDistance

`ToolPathSplitParametersBuilder.``OverlapDistance`

  Returns the overlap distance builder

  `-------------------------------------`

  Getter Method

  Signature `OverlapDistance`

  Returns: | the overlap distance builder
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX9.0.0.

  License requirements: None.

## SplitType

`ToolPathSplitParametersBuilder.``SplitType`

  Returns or sets the type of split (by tranfer or collision)

  `-------------------------------------`

  Getter Method

  Signature `SplitType`

  Returns: |
  Return type: | `NXOpen.CAM.ToolPathSplitParametersBuilderSplitTypes`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SplitType`

  Parameters: | splitTypeValue (`NXOpen.CAM.ToolPathSplitParametersBuilderSplitTypes`) –

  New in version NX6.0.0.

  License requirements: None.

## TransferHeight

`ToolPathSplitParametersBuilder.``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`

  Parameters: | transferHeight (float) –

  New in version NX6.0.0.

  License requirements: None.

## TransferHeightBuilder

`ToolPathSplitParametersBuilder.``TransferHeightBuilder`

  Returns the transfer height builder

  `-------------------------------------`

  Getter Method

  Signature `TransferHeightBuilder`

  Returns: | the transfer height builder
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX9.0.0.

  License requirements: None.

## TransferType

`ToolPathSplitParametersBuilder.``TransferType`

  Returns or sets the transfer type (direct, clearance, lowest safe z)

  `-------------------------------------`

  Getter Method

  Signature `TransferType`

  Returns: |
  Return type: | `NXOpen.CAM.ToolPathSplitParametersBuilderTransferTypes`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TransferType`

  Parameters: | transferType (`NXOpen.CAM.ToolPathSplitParametersBuilderTransferTypes`) –

  New in version NX6.0.0.

  License requirements: None.

## TransferUsingMethod

`ToolPathSplitParametersBuilder.``TransferUsingMethod`

  Returns or sets the transfer using method (none, ramp on shape, lift and plunge)

  `-------------------------------------`

  Getter Method

  Signature `TransferUsingMethod`

  Returns: |
  Return type: | `NXOpen.CAM.ToolPathSplitParametersBuilderTransferUsingMethods`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TransferUsingMethod`

  Parameters: | transferUsingMethod (`NXOpen.CAM.ToolPathSplitParametersBuilderTransferUsingMethods`) –

  New in version NX6.0.0.

  License requirements: None.

## TrimmingSteepAngle

`ToolPathSplitParametersBuilder.``TrimmingSteepAngle`

  Returns or sets the trimming steep angle

  `-------------------------------------`

  Getter Method

  Signature `TrimmingSteepAngle`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TrimmingSteepAngle`

  Parameters: | trimmingSteepAngle (float) –

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

# Method Detail

## Validate

`ToolPathSplitParametersBuilder.``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.