TurningOperationBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# TurningOperationBuilder Class

class `NXOpen.CAM.``TurningOperationBuilder`

  Bases: `NXOpen.CAM.OperationBuilder`

  Represents a Turning Operation Builder

  This is an abstract class and cannot be instantiated.

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
AdditionalCommands | Returns or sets the Additional Commands
ChannelName | Returns or sets the channel’s name
CycleEvent | Returns the cycle event
CycleTable | Returns the cycle
Description | Returns or sets the description
EndOfPath | Returns the end event builder
EndUdeSet | Returns the end ude set
FeedsBuilder | Returns the feeds and speeds builder
FlipToolAroundHolder | Returns or sets the Flip Tool Around Holder toggle
Geometry | Returns the geometry builder
GougeChecking | Returns or sets the gouge checking flag
HoleAxisType | Returns or sets the Hole Axis Type
HoleDepth | Returns the max depth distance builder
HoleDepthType | Returns or sets the Hole Depth Type
LayoutAndLayer | Returns the Layer and Layout
MachineCycleSubroutineName | Returns or sets the machine cycle subroutine name
MotionOutput | Returns or sets the motion output
MotionOutputBuilder | Returns the motion output builder
Notes | Returns the notes builder
OptimizationBasedOn | Returns or sets the optimization based on in operation
OptimizationDistanceMethod | Returns or sets the optimization distance method in operation
OptimizationLevel | Returns or sets the optimization level in operation
OptimizationMethod | Returns or sets the optim method
PathDisplayOptions | Returns the path display options builder
PostToolPathExit | Returns or sets the environment variable that points to the post tool path generation library which has the exit
ReorientToolHolder | Returns or sets the Reorient Tool Holder toggle.
ReorientToolHolderMode | Returns or sets the Reorient Tool Holder Mode
RetractDistance | Returns the Retract Distance builder (inheritable double)
RetractDistanceOnToolAxisChange | Returns the Retract Distance on Tool Axis Change builder (inheritable double)
RotateTrackingPoint | Returns or sets the Rotate Tracking Point toggle
SafeClearance | Returns the safe clearance builder
SelectToolFlag | Returns or sets the user selected tool
StartOfPath | Returns the start event builder
StartUdeSet | Returns the start ude set
Tag | Returns the Tag for this object.
ToolChangeSetting | Returns the tool change builder
ToolHolderAngle | Returns the Tool Holder Angle
ToolPathEditor | Returns the Tool Path Editor Builder
ToolPathSplitParametersBuilder | Returns the tool path split Parameters
TrackingPointStatus | Returns or sets the tracking point status
UpdateIpw | Returns or sets the update IPW mode
UseMachineCycle | Returns or sets the Use Machine Cycle toggle

# 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.
GetCustomizableItemBuilder | Returns the customizable item builder for the given customizable item name
GetCustomizableItemNames | Returns the names for all customizable item ids
GetHoleAxisValues | Get the Hole Axis values
GetObject | Returns the object currently being edited by this builder.
SetHoleAxisValues | Set the Hole Axis values
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

TurningOperationBuilderMotionOutputOptions Enumeration | The motion output options
TurningOperationBuilderReorientToolHolderModeOptions Enumeration | available options for Reorient Tool Holder Mode
TurningOperationBuilderTrackingPointType Enumeration | available types for tracking point

# Property Detail

## AdditionalCommands

`TurningOperationBuilder.``AdditionalCommands`

  Returns or sets the Additional Commands

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

  Getter Method

  Signature `AdditionalCommands`

  Returns: | the additional commands
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AdditionalCommands`

  Parameters: | additionalCommands (str) – the additional commands

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## FeedsBuilder

`TurningOperationBuilder.``FeedsBuilder`

  Returns the feeds and speeds builder

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

  Getter Method

  Signature `FeedsBuilder`

  Returns: | the feeds and speeds builder
  Return type: | `NXOpen.CAM.FeedsTurnBuilder`

  New in version NX6.0.0.

  License requirements: None.

## FlipToolAroundHolder

`TurningOperationBuilder.``FlipToolAroundHolder`

  Returns or sets the Flip Tool Around Holder toggle

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

  Getter Method

  Signature `FlipToolAroundHolder`

  Returns: | the machine’s A-axis
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `FlipToolAroundHolder`

  Parameters: | machAAxis (bool) – the machine’s A-axis

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## MachineCycleSubroutineName

`TurningOperationBuilder.``MachineCycleSubroutineName`

  Returns or sets the machine cycle subroutine name

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

  Getter Method

  Signature `MachineCycleSubroutineName`

  Returns: | the machine cycle subroutine name
  Return type: | str

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MachineCycleSubroutineName`

  Parameters: | machineCycleSubroutineName (str) – the machine cycle subroutine name

  New in version NX8.0.0.

  License requirements: cam_base (“CAM BASE”)

## MotionOutput

`TurningOperationBuilder.``MotionOutput`

  Returns or sets the motion output

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

  Getter Method

  Signature `MotionOutput`

  Returns: | the motion output
  Return type: | `NXOpen.CAM.TurningOperationBuilderMotionOutputOptions`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MotionOutput`

  Parameters: | motionOutput (`NXOpen.CAM.TurningOperationBuilderMotionOutputOptions`) – the motion output

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## ReorientToolHolder

`TurningOperationBuilder.``ReorientToolHolder`

  Returns or sets the Reorient Tool Holder toggle.

  IMPORTANT: Parameter is obsolete from NX11.0 on and must not be used longer.

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

  Getter Method

  Signature `ReorientToolHolder`

  Returns: | Reorient Tool Holder
  Return type: | bool

  New in version NX6.0.0.

  Deprecated since version NX11.0.0: Use ‘Reorient Tool Holder Mode’ instead.

  License requirements: None.

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

  Setter Method

  Signature `ReorientToolHolder`

  Parameters: | reorient (bool) – Reorient Tool Holder

  New in version NX6.0.0.

  Deprecated since version NX11.0.0: Use ‘Reorient Tool Holder Mode’ instead.

  License requirements: cam_base (“CAM BASE”)

## ReorientToolHolderMode

`TurningOperationBuilder.``ReorientToolHolderMode`

  Returns or sets the Reorient Tool Holder Mode

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

  Getter Method

  Signature `ReorientToolHolderMode`

  Returns: | Reorient Tool Holder Mode
  Return type: | `NXOpen.CAM.TurningOperationBuilderReorientToolHolderModeOptions`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ReorientToolHolderMode`

  Parameters: | reorientToolHolderMode (`NXOpen.CAM.TurningOperationBuilderReorientToolHolderModeOptions`) – Reorient Tool Holder Mode

  New in version NX11.0.0.

  License requirements: cam_base (“CAM BASE”)

## RotateTrackingPoint

`TurningOperationBuilder.``RotateTrackingPoint`

  Returns or sets the Rotate Tracking Point toggle

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

  Getter Method

  Signature `RotateTrackingPoint`

  Returns: | Rotate Tracking Point
  Return type: | bool

  New in version NX7.5.0.

  Deprecated since version NX8.5.0: Use `CAM.TurningOperationBuilder.TrackingPointStatus`()` instead.

  License requirements: None.

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

  Setter Method

  Signature `RotateTrackingPoint`

  Parameters: | rotate (bool) – Rotate Tracking Point

  New in version NX7.5.0.

  Deprecated since version NX8.5.0: Use `CAM.TurningOperationBuilder.TrackingPointStatus`()` instead.

  License requirements: cam_base (“CAM BASE”)

## ToolHolderAngle

`TurningOperationBuilder.``ToolHolderAngle`

  Returns the Tool Holder Angle

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

  Getter Method

  Signature `ToolHolderAngle`

  Returns: | the Tool Holder Angle builder
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX6.0.0.

  License requirements: None.

## TrackingPointStatus

`TurningOperationBuilder.``TrackingPointStatus`

  Returns or sets the tracking point status

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

  Getter Method

  Signature `TrackingPointStatus`

  Returns: | tracking point status
  Return type: | `NXOpen.CAM.TurningOperationBuilderTrackingPointType`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `TrackingPointStatus`

  Parameters: | status (`NXOpen.CAM.TurningOperationBuilderTrackingPointType`) – tracking point status

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## UpdateIpw

`TurningOperationBuilder.``UpdateIpw`

  Returns or sets the update IPW mode

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

  Getter Method

  Signature `UpdateIpw`

  Returns: | the update IPW mode
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UpdateIpw`

  Parameters: | updateIpwMode (bool) – the update IPW mode

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## UseMachineCycle

`TurningOperationBuilder.``UseMachineCycle`

  Returns or sets the Use Machine Cycle toggle

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

  Getter Method

  Signature `UseMachineCycle`

  Returns: | the machine cycle
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UseMachineCycle`

  Parameters: | machineCycle (bool) – the machine cycle

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

# Method Detail

## Validate

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