NcmTurnThreadBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# NcmTurnThreadBuilder Class

class `NXOpen.CAM.``NcmTurnThreadBuilder`

  Bases: `NXOpen.CAM.NcmTurningBuilder`

  Represents a CAM.

  NcmTurnThreadBuilder .. versionadded:: NX6.0.0

# Properties

Property | Description
--- | ---
AvoidanceAfterLastRetract | Returns or sets the prefer direct motion after last retract
AvoidanceApproachBuilder | Returns the approach path builder
AvoidanceBetweenRegions | Returns or sets the prefer direct motion between regions
AvoidanceClearanceBuilder | Returns the clearance builder
AvoidanceDepartureBuilder | Returns the departure path builder
AvoidanceFromBuilder | Returns the avoidance from builder
AvoidanceGohomeBuilder | Returns the gohome point builder
AvoidanceReturnBuilder | Returns the return path builder
AvoidanceStartBuilder | Returns the avoidance start builder
AvoidanceStartOfEngageBuilder | Returns the start of engage builder
AvoidanceToStartOfEngage | Returns or sets the prefer direct motion to start of engage
Cutcom | Returns the cutter compensation builder
DefaultRegionStartType | Returns or sets the region start type
EngageBuilder | Returns the Engage builder
LocalReturnFinishGetEndEvents | Returns the Local Return Finish End Events
LocalReturnFinishGetStartEvents | Returns the Local Return Finish Start Events
LocalReturnFinishMode | Returns or sets the Local Return Finish Mode
LocalReturnFinishMove | Returns or sets the Local Return Finish Move
LocalReturnFinishNumberOfPasses | Returns or sets the Local Return Finish Number of Passes
LocalReturnFinishPoint | Returns or sets the Local Return Finish Point
LocalReturnMode | Returns or sets the Local Return Mode
LocalReturnMove | Returns or sets the Local Return Move
LocalReturnPoint | Returns or sets the Local Return Point
LocalReturnRoughGetEndEvents | Returns the Local Return Rough End Events
LocalReturnRoughGetStartEvents | Returns the Local Return Rough Start Events
LocalReturnRoughMode | Returns or sets the Local Return Rough Mode
LocalReturnRoughMove | Returns or sets the Local Return Rough Move
LocalReturnRoughNumberOfPasses | Returns or sets the Local Return Rough Number of Passes
LocalReturnRoughPoint | Returns or sets the Local Return Rough Point
MinimumClearanceBuilder | Returns the Minimum Clearance
NcmHoleMachiningBuilder | Returns the non cutting moves hole machining builder
Opstops | Returns or sets the Opstops
RetractBuilder | Returns the Retract builder
StartPointsEffectDistBuilder | Returns the region start points effective distance builder (inheritable tool dep)
StartPointsUseEffectDist | Returns or sets the start points use effective distance
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
GetCustomizableItemBuilder | Returns the customizable item builder for given customizable item name
GetCustomizableItemNames | Returns the names for all customizable item ids
GetRegionStartPoints | Returns region start points
SetRegionStartPoints | Sets region start points
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

NcmTurnThreadBuilderLocalReturnMainModes Enumeration | The Local Return Main modes options
NcmTurnThreadBuilderLocalReturnModes Enumeration | The Local Return modes options
NcmTurnThreadBuilderLocalReturnTypes Enumeration | The Cut regions type options

# Property Detail

## EngageBuilder

`NcmTurnThreadBuilder.``EngageBuilder`

  Returns the Engage builder

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

  Getter Method

  Signature `EngageBuilder`

  Returns: | the Engage builder
  Return type: | `NXOpen.CAM.TurnThreadEngageRetractBuilder`

  New in version NX6.0.0.

  License requirements: None.

## LocalReturnFinishGetEndEvents

`NcmTurnThreadBuilder.``LocalReturnFinishGetEndEvents`

  Returns the Local Return Finish End Events

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

  Getter Method

  Signature `LocalReturnFinishGetEndEvents`

  Returns: | the Local Return Finish End Events
  Return type: | `NXOpen.CAM.PostEventsCiBuilder`

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## LocalReturnFinishGetStartEvents

`NcmTurnThreadBuilder.``LocalReturnFinishGetStartEvents`

  Returns the Local Return Finish Start Events

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

  Getter Method

  Signature `LocalReturnFinishGetStartEvents`

  Returns: | the Local Return Finish Start Events
  Return type: | `NXOpen.CAM.PostEventsCiBuilder`

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## LocalReturnFinishMode

`NcmTurnThreadBuilder.``LocalReturnFinishMode`

  Returns or sets the Local Return Finish Mode

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

  Getter Method

  Signature `LocalReturnFinishMode`

  Returns: | the Local Return Finish Mode
  Return type: | `NXOpen.CAM.NcmTurnThreadBuilderLocalReturnModes`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `LocalReturnFinishMode`

  Parameters: | localReturnFinishMode (`NXOpen.CAM.NcmTurnThreadBuilderLocalReturnModes`) – the Local Return Finish Mode

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## LocalReturnFinishMove

`NcmTurnThreadBuilder.``LocalReturnFinishMove`

  Returns or sets the Local Return Finish Move

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

  Getter Method

  Signature `LocalReturnFinishMove`

  Returns: | the Local Return Finish Move
  Return type: | `NXOpen.CAM.NcmTurnThreadBuilderLocalReturnTypes`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `LocalReturnFinishMove`

  Parameters: | localReturnFinishMove (`NXOpen.CAM.NcmTurnThreadBuilderLocalReturnTypes`) – the Local Return Finish Move

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## LocalReturnFinishNumberOfPasses

`NcmTurnThreadBuilder.``LocalReturnFinishNumberOfPasses`

  Returns or sets the Local Return Finish Number of Passes

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

  Getter Method

  Signature `LocalReturnFinishNumberOfPasses`

  Returns: | the Local Return Finish Number of Passes
  Return type: | int

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `LocalReturnFinishNumberOfPasses`

  Parameters: | localReturnFinishNumberOfPasses (int) – the Local Return Finish Number of Passes

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## LocalReturnFinishPoint

`NcmTurnThreadBuilder.``LocalReturnFinishPoint`

  Returns or sets the Local Return Finish Point

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

  Getter Method

  Signature `LocalReturnFinishPoint`

  Returns: | the Local Return Finish Point
  Return type: | `NXOpen.Point`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `LocalReturnFinishPoint`

  Parameters: | localReturnFinishPoint (`NXOpen.Point`) – the Local Return Finish Point

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## LocalReturnMode

`NcmTurnThreadBuilder.``LocalReturnMode`

  Returns or sets the Local Return Mode

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

  Getter Method

  Signature `LocalReturnMode`

  Returns: | the Local Return Main Mode
  Return type: | `NXOpen.CAM.NcmTurnThreadBuilderLocalReturnMainModes`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `LocalReturnMode`

  Parameters: | localReturnMode (`NXOpen.CAM.NcmTurnThreadBuilderLocalReturnMainModes`) – the Local Return Main Mode

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## LocalReturnMove

`NcmTurnThreadBuilder.``LocalReturnMove`

  Returns or sets the Local Return Move

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

  Getter Method

  Signature `LocalReturnMove`

  Returns: | the Local Return Move
  Return type: | `NXOpen.CAM.NcmTurnThreadBuilderLocalReturnTypes`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LocalReturnMove`

  Parameters: | localMove (`NXOpen.CAM.NcmTurnThreadBuilderLocalReturnTypes`) – the Local Return Move

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## LocalReturnPoint

`NcmTurnThreadBuilder.``LocalReturnPoint`

  Returns or sets the Local Return Point

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

  Getter Method

  Signature `LocalReturnPoint`

  Returns: | the Local Return Point
  Return type: | `NXOpen.Point`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LocalReturnPoint`

  Parameters: | localPoint (`NXOpen.Point`) – the Local Return Point

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## LocalReturnRoughGetEndEvents

`NcmTurnThreadBuilder.``LocalReturnRoughGetEndEvents`

  Returns the Local Return Rough End Events

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

  Getter Method

  Signature `LocalReturnRoughGetEndEvents`

  Returns: | the Local Return Rough End Events
  Return type: | `NXOpen.CAM.PostEventsCiBuilder`

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## LocalReturnRoughGetStartEvents

`NcmTurnThreadBuilder.``LocalReturnRoughGetStartEvents`

  Returns the Local Return Rough Start Events

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

  Getter Method

  Signature `LocalReturnRoughGetStartEvents`

  Returns: | the Local Return Rough Start Events
  Return type: | `NXOpen.CAM.PostEventsCiBuilder`

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## LocalReturnRoughMode

`NcmTurnThreadBuilder.``LocalReturnRoughMode`

  Returns or sets the Local Return Rough Mode

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

  Getter Method

  Signature `LocalReturnRoughMode`

  Returns: | the Local Return Rough Mode
  Return type: | `NXOpen.CAM.NcmTurnThreadBuilderLocalReturnModes`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `LocalReturnRoughMode`

  Parameters: | localReturnRoughMode (`NXOpen.CAM.NcmTurnThreadBuilderLocalReturnModes`) – the Local Return Rough Mode

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## LocalReturnRoughMove

`NcmTurnThreadBuilder.``LocalReturnRoughMove`

  Returns or sets the Local Return Rough Move

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

  Getter Method

  Signature `LocalReturnRoughMove`

  Returns: | the Local Return Rough Move
  Return type: | `NXOpen.CAM.NcmTurnThreadBuilderLocalReturnTypes`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `LocalReturnRoughMove`

  Parameters: | localReturnRoughMove (`NXOpen.CAM.NcmTurnThreadBuilderLocalReturnTypes`) – the Local Return Rough Move

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## LocalReturnRoughNumberOfPasses

`NcmTurnThreadBuilder.``LocalReturnRoughNumberOfPasses`

  Returns or sets the Local Return Rough Number of Passes

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

  Getter Method

  Signature `LocalReturnRoughNumberOfPasses`

  Returns: | the Local Return Rough Number of Passes
  Return type: | int

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `LocalReturnRoughNumberOfPasses`

  Parameters: | localReturnRoughNumberOfPasses (int) – the Local Return Rough Number of Passes

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## LocalReturnRoughPoint

`NcmTurnThreadBuilder.``LocalReturnRoughPoint`

  Returns or sets the Local Return Rough Point

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

  Getter Method

  Signature `LocalReturnRoughPoint`

  Returns: | the Local Return Rough Point
  Return type: | `NXOpen.Point`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `LocalReturnRoughPoint`

  Parameters: | localReturnRoughPoint (`NXOpen.Point`) – the Local Return Rough Point

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## MinimumClearanceBuilder

`NcmTurnThreadBuilder.``MinimumClearanceBuilder`

  Returns the Minimum Clearance

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

  Getter Method

  Signature `MinimumClearanceBuilder`

  Returns: | the Minimum Clearance builder
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX6.0.0.

  License requirements: None.

## Opstops

`NcmTurnThreadBuilder.``Opstops`

  Returns or sets the Opstops

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

  Getter Method

  Signature `Opstops`

  Returns: | the Opstops
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Opstops`

  Parameters: | opstops (int) – the Opstops

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## RetractBuilder

`NcmTurnThreadBuilder.``RetractBuilder`

  Returns the Retract builder

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

  Getter Method

  Signature `RetractBuilder`

  Returns: | the Retract builder
  Return type: | `NXOpen.CAM.TurnThreadEngageRetractBuilder`

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## Validate

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