TurnRoughFinishLocalReturnBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# TurnRoughFinishLocalReturnBuilder Class

class `NXOpen.CAM.``TurnRoughFinishLocalReturnBuilder`

  Bases: `NXOpen.TaggedObject`

  Represents an avoidance start Builder

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
AdjustmentMode | Returns or sets the adjustment mode mode
Distance | Returns or sets the local distance value
Dwell | Returns or sets the Dwell Time or Revolutions
DwellUnit | Returns or sets the Dwell Unit type
EndOfPathBuilder | Returns the end event builder
LowerLimit | Returns or sets the lower limit
Mode | Returns or sets the local return type
NumberOfCuts | Returns or sets the local number of cuts
NumberOfLevels | Returns or sets the local number of levels
NumberOfPasses | Returns or sets the local number of passes value
OperatorMessage | Returns or sets the Operator Message String
OutputOperatorMessage | Returns or sets the output operator message option
OutputOpskip | Returns or sets the output opskip option
OutputOpstop | Returns or sets the output opstop option
OutputStop | Returns or sets the output stop option
Point | Returns or sets the local return point
ReturnMoveMode | Returns or sets the adjustment mode mode
StartOfPathBuilder | Returns the start event builder
Tag | Returns the Tag for this object.
Time | Returns or sets the local time value
UpperLimit | Returns or sets the upper limit

# Methods

Method | Description
--- | ---
GetLowerLimitType | Get the lower limits mode
GetUpperLimitType | Get the upper limits mode
SetLowerLimitType | Set the lower limits mode
SetUpperLimitType | Set the upper limits mode

# Enumerations

TurnRoughFinishLocalReturnBuilderAdjustmentModeTypes Enumeration | the adjustment mode options
TurnRoughFinishLocalReturnBuilderDwellUnitTypes Enumeration | the Dwell Unit type
TurnRoughFinishLocalReturnBuilderLimitTypes Enumeration | the local limit mode
TurnRoughFinishLocalReturnBuilderModeTypes Enumeration | The local return type options
TurnRoughFinishLocalReturnBuilderReturnMoveModeTypes Enumeration | the return move mode options

# Property Detail

## AdjustmentMode

`TurnRoughFinishLocalReturnBuilder.``AdjustmentMode`

  Returns or sets the adjustment mode mode

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

  Getter Method

  Signature `AdjustmentMode`

  Returns: | the adjustment mode value
  Return type: | `NXOpen.CAM.TurnRoughFinishLocalReturnBuilderAdjustmentModeTypes`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AdjustmentMode`

  Parameters: | adjustmentMode (`NXOpen.CAM.TurnRoughFinishLocalReturnBuilderAdjustmentModeTypes`) – the adjustment mode value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## Distance

`TurnRoughFinishLocalReturnBuilder.``Distance`

  Returns or sets the local distance value

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

  Getter Method

  Signature `Distance`

  Returns: | the local distance value
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Distance`

  Parameters: | localDistanceValue (float) – the local distance value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## Dwell

`TurnRoughFinishLocalReturnBuilder.``Dwell`

  Returns or sets the Dwell Time or Revolutions

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

  Getter Method

  Signature `Dwell`

  Returns: | the Dwell Time or Revolutions value
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Dwell`

  Parameters: | dwell (float) – the Dwell Time or Revolutions value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## DwellUnit

`TurnRoughFinishLocalReturnBuilder.``DwellUnit`

  Returns or sets the Dwell Unit type

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

  Getter Method

  Signature `DwellUnit`

  Returns: | the Dwell Unit value
  Return type: | `NXOpen.CAM.TurnRoughFinishLocalReturnBuilderDwellUnitTypes`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DwellUnit`

  Parameters: | dwellUnit (`NXOpen.CAM.TurnRoughFinishLocalReturnBuilderDwellUnitTypes`) – the Dwell Unit value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## EndOfPathBuilder

`TurnRoughFinishLocalReturnBuilder.``EndOfPathBuilder`

  Returns the end event builder

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

  Getter Method

  Signature `EndOfPathBuilder`

  Returns: | the end of path builder
  Return type: | `NXOpen.CAM.PostEventsCiBuilder`

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## LowerLimit

`TurnRoughFinishLocalReturnBuilder.``LowerLimit`

  Returns or sets the lower limit

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

  Getter Method

  Signature `LowerLimit`

  Returns: | the lower limit value
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LowerLimit`

  Parameters: | lowerLimitValue (float) – the lower limit value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## Mode

`TurnRoughFinishLocalReturnBuilder.``Mode`

  Returns or sets the local return type

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

  Getter Method

  Signature `Mode`

  Returns: | the start local return type value
  Return type: | `NXOpen.CAM.TurnRoughFinishLocalReturnBuilderModeTypes`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Mode`

  Parameters: | localReturnModeType (`NXOpen.CAM.TurnRoughFinishLocalReturnBuilderModeTypes`) – the start local return type value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## NumberOfCuts

`TurnRoughFinishLocalReturnBuilder.``NumberOfCuts`

  Returns or sets the local number of cuts

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

  Getter Method

  Signature `NumberOfCuts`

  Returns: | the local number of cuts value
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NumberOfCuts`

  Parameters: | localNumberOfCutsValue (int) – the local number of cuts value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## NumberOfLevels

`TurnRoughFinishLocalReturnBuilder.``NumberOfLevels`

  Returns or sets the local number of levels

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

  Getter Method

  Signature `NumberOfLevels`

  Returns: | the local number of levels value
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NumberOfLevels`

  Parameters: | localNumberOfLevelsValue (int) – the local number of levels value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## NumberOfPasses

`TurnRoughFinishLocalReturnBuilder.``NumberOfPasses`

  Returns or sets the local number of passes value

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

  Getter Method

  Signature `NumberOfPasses`

  Returns: | the local number of passes value
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NumberOfPasses`

  Parameters: | localNumberOfPassesValue (int) – the local number of passes value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## OperatorMessage

`TurnRoughFinishLocalReturnBuilder.``OperatorMessage`

  Returns or sets the Operator Message String

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

  Getter Method

  Signature `OperatorMessage`

  Returns: | the Operator Message String value
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OperatorMessage`

  Parameters: | operatorMessage (str) – the Operator Message String value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## OutputOperatorMessage

`TurnRoughFinishLocalReturnBuilder.``OutputOperatorMessage`

  Returns or sets the output operator message option

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

  Getter Method

  Signature `OutputOperatorMessage`

  Returns: | the Operator Message value
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputOperatorMessage`

  Parameters: | operatorMessage (bool) – the Operator Message value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## OutputOpskip

`TurnRoughFinishLocalReturnBuilder.``OutputOpskip`

  Returns or sets the output opskip option

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

  Getter Method

  Signature `OutputOpskip`

  Returns: | the Opskip value
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputOpskip`

  Parameters: | opskipValue (bool) – the Opskip value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## OutputOpstop

`TurnRoughFinishLocalReturnBuilder.``OutputOpstop`

  Returns or sets the output opstop option

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

  Getter Method

  Signature `OutputOpstop`

  Returns: | the Opstop value
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputOpstop`

  Parameters: | opstopValue (bool) – the Opstop value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## OutputStop

`TurnRoughFinishLocalReturnBuilder.``OutputStop`

  Returns or sets the output stop option

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

  Getter Method

  Signature `OutputStop`

  Returns: | the Stop value
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputStop`

  Parameters: | stopValue (bool) – the Stop value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## Point

`TurnRoughFinishLocalReturnBuilder.``Point`

  Returns or sets the local return point

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

  Getter Method

  Signature `Point`

  Returns: | the local return point value
  Return type: | `NXOpen.Point`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Point`

  Parameters: | localReturnPoint (`NXOpen.Point`) – the local return point value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## ReturnMoveMode

`TurnRoughFinishLocalReturnBuilder.``ReturnMoveMode`

  Returns or sets the adjustment mode mode

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

  Getter Method

  Signature `ReturnMoveMode`

  Returns: | the return move mode value
  Return type: | `NXOpen.CAM.TurnRoughFinishLocalReturnBuilderReturnMoveModeTypes`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ReturnMoveMode`

  Parameters: | returnMoveMode (`NXOpen.CAM.TurnRoughFinishLocalReturnBuilderReturnMoveModeTypes`) – the return move mode value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## StartOfPathBuilder

`TurnRoughFinishLocalReturnBuilder.``StartOfPathBuilder`

  Returns the start event builder

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

  Getter Method

  Signature `StartOfPathBuilder`

  Returns: | the start of path builder
  Return type: | `NXOpen.CAM.PostEventsCiBuilder`

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## Time

`TurnRoughFinishLocalReturnBuilder.``Time`

  Returns or sets the local time value

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

  Getter Method

  Signature `Time`

  Returns: | the local time value
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Time`

  Parameters: | localTimeValue (float) – the local time value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## UpperLimit

`TurnRoughFinishLocalReturnBuilder.``UpperLimit`

  Returns or sets the upper limit

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

  Getter Method

  Signature `UpperLimit`

  Returns: | the upper limit value
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UpperLimit`

  Parameters: | upperLimitValue (float) – the upper limit value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

# Method Detail

## GetLowerLimitType

`TurnRoughFinishLocalReturnBuilder.``GetLowerLimitType`

  Get the lower limits mode

  Signature `GetLowerLimitType()`

  Returns: | the lower limits mode value
  Return type: | `NXOpen.CAM.TurnRoughFinishLocalReturnBuilderLimitTypes`

  New in version NX6.0.0.

  License requirements: None.

## GetUpperLimitType

`TurnRoughFinishLocalReturnBuilder.``GetUpperLimitType`

  Get the upper limits mode

  Signature `GetUpperLimitType()`

  Returns: | the upper limits mode value
  Return type: | `NXOpen.CAM.TurnRoughFinishLocalReturnBuilderLimitTypes`

  New in version NX6.0.0.

  License requirements: None.

## SetLowerLimitType

`TurnRoughFinishLocalReturnBuilder.``SetLowerLimitType`

  Set the lower limits mode

  Signature `SetLowerLimitType(lowerLimitModeValue)`

  Parameters: | lowerLimitModeValue (`NXOpen.CAM.TurnRoughFinishLocalReturnBuilderLimitTypes`) – the lower limits mode value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## SetUpperLimitType

`TurnRoughFinishLocalReturnBuilder.``SetUpperLimitType`

  Set the upper limits mode

  Signature `SetUpperLimitType(upperLimitModeValue)`

  Parameters: | upperLimitModeValue (`NXOpen.CAM.TurnRoughFinishLocalReturnBuilderLimitTypes`) – the upper limits mode value

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)