NcmTurnRoughFinishBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# NcmTurnRoughFinishBuilder Class

class `NXOpen.CAM.``NcmTurnRoughFinishBuilder`

  Bases: `NXOpen.CAM.NcmTurningBuilder`

  Represents a CAM.

  NcmTurnRoughFinishBuilder .. 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
AvoidanceForAutomaticEngage | Returns or sets the additional checking for automatic engage
AvoidanceForAutomaticRetract | Returns or sets the additional checking for automatic retract
AvoidanceForMinimumClearance | Returns or sets the additional checking for minimum clearance
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
AxialSafeClearance | Returns or sets the axial safe clearance value
Cutcom | Returns the cutter compensation builder
DefaultRegionStartType | Returns or sets the region start type
EngageProfileBuilder | Returns the Profiling Engage builder
LocalReturnBuilder | Returns the Local Return builder
NcmHoleMachiningBuilder | Returns the non cutting moves hole machining builder
RadialSafeClearance | Returns or sets the radial safe clearance value
RetractProfileBuilder | Returns the Profiling 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.

# Property Detail

## AvoidanceForAutomaticEngage

`NcmTurnRoughFinishBuilder.``AvoidanceForAutomaticEngage`

  Returns or sets the additional checking for automatic engage

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

  Getter Method

  Signature `AvoidanceForAutomaticEngage`

  Returns: | the additional checking for automatic engage
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AvoidanceForAutomaticEngage`

  Parameters: | avoidanceAutomaticEngage (bool) – the additional checking for automatic engage

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## AvoidanceForAutomaticRetract

`NcmTurnRoughFinishBuilder.``AvoidanceForAutomaticRetract`

  Returns or sets the additional checking for automatic retract

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

  Getter Method

  Signature `AvoidanceForAutomaticRetract`

  Returns: | the additional checking for automatic retract
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AvoidanceForAutomaticRetract`

  Parameters: | avoidanceAutomaticRetract (bool) – the additional checking for automatic retract

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## AvoidanceForMinimumClearance

`NcmTurnRoughFinishBuilder.``AvoidanceForMinimumClearance`

  Returns or sets the additional checking for minimum clearance

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

  Getter Method

  Signature `AvoidanceForMinimumClearance`

  Returns: | the additional checking for minimum clearance
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AvoidanceForMinimumClearance`

  Parameters: | avoidanceMinimumClearance (bool) – the additional checking for minimum clearance

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## AxialSafeClearance

`NcmTurnRoughFinishBuilder.``AxialSafeClearance`

  Returns or sets the axial safe clearance value

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

  Getter Method

  Signature `AxialSafeClearance`

  Returns: | the axial safe clearance value
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AxialSafeClearance`

  Parameters: | axialSafeClearanceValue (float) – the axial safe clearance value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## EngageProfileBuilder

`NcmTurnRoughFinishBuilder.``EngageProfileBuilder`

  Returns the Profiling Engage builder

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

  Getter Method

  Signature `EngageProfileBuilder`

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

  New in version NX6.0.0.

  License requirements: None.

## LocalReturnBuilder

`NcmTurnRoughFinishBuilder.``LocalReturnBuilder`

  Returns the Local Return builder

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

  Getter Method

  Signature `LocalReturnBuilder`

  Returns: | the Local Return builder
  Return type: | `NXOpen.CAM.TurnRoughFinishLocalReturnBuilder`

  New in version NX6.0.0.

  License requirements: None.

## RadialSafeClearance

`NcmTurnRoughFinishBuilder.``RadialSafeClearance`

  Returns or sets the radial safe clearance value

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

  Getter Method

  Signature `RadialSafeClearance`

  Returns: | the radial safe clearance value
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RadialSafeClearance`

  Parameters: | radialSafeClearanceValue (float) – the radial safe clearance value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## RetractProfileBuilder

`NcmTurnRoughFinishBuilder.``RetractProfileBuilder`

  Returns the Profiling Retract builder

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

  Getter Method

  Signature `RetractProfileBuilder`

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

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## Validate

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