ThreadTurningBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ThreadTurningBuilder Class

class `NXOpen.CAM.``ThreadTurningBuilder`

  Bases: `NXOpen.CAM.TurningOperationBuilder`

  Represents a ThreadTurning Builder

  To create a new instance of this class, use `NXOpen.CAM.OperationCollection.CreateThreadTurningBuilder()`

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
AdditionalCommands | Returns or sets the Additional Commands
ChannelName | Returns or sets the channel’s name
CrestLine | Returns or sets the Crest Line
CrestLineDirection | Returns or sets the Crest Line Direction(Start and End Points)
CrestOffset | Returns the crest offset builder
CutParameters | Returns the cut parameter object
CycleEvent | Returns the cycle event
CycleTable | Returns the cycle
DepthOption | Returns or sets the depth option
Description | Returns or sets the description
EndLine | Returns or sets the End Line
EndOfPath | Returns the end event builder
EndOffset | Returns the End Offset
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
InfeedLength | Returns the infeed length
InfeedLengthType | Returns or sets the infeed length type
InfeedMode | Returns or sets the infeed mode
InfeedMoveAngle | Returns the infeed move angle
InfeedStartLineAngle | Returns the infeed start line angle
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
NonCuttingBuilder | Returns the non-cutting 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)
RootLine | Returns or sets the Root Line
RootOffset | Returns the root offset
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
StartOffset | Returns the Start Offset
StartUdeSet | Returns the start ude set
Tag | Returns the Tag for this object.
ThreadAngleBuilder | Returns the thread angle
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
TotalDepth | Returns the Total Depth
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

ThreadTurningBuilderDepthOptionTypes Enumeration | the Depth Option types
ThreadTurningBuilderInfeedLengthTypes Enumeration | the Infeed Length Types
ThreadTurningBuilderInfeedModes Enumeration | the Infeed modes

# Property Detail

## CrestLine

`ThreadTurningBuilder.``CrestLine`

  Returns or sets the Crest Line

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

  Getter Method

  Signature `CrestLine`

  Returns: | the Crest Line tag
  Return type: | `NXOpen.NXObject`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CrestLine`

  Parameters: | crestLine (`NXOpen.NXObject`) – the Crest Line tag

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## CrestLineDirection

`ThreadTurningBuilder.``CrestLineDirection`

  Returns or sets the Crest Line Direction(Start and End Points)

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

  Getter Method

  Signature `CrestLineDirection`

  Returns: | the Crest Line Direction tag
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CrestLineDirection`

  Parameters: | crestLineDirection (bool) – the Crest Line Direction tag

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## CrestOffset

`ThreadTurningBuilder.``CrestOffset`

  Returns the crest offset builder

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

  Getter Method

  Signature `CrestOffset`

  Returns: | the crest offset
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX6.0.0.

  License requirements: None.

## CutParameters

`ThreadTurningBuilder.``CutParameters`

  Returns the cut parameter object

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

  Getter Method

  Signature `CutParameters`

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

  New in version NX6.0.0.

  License requirements: None.

## DepthOption

`ThreadTurningBuilder.``DepthOption`

  Returns or sets the depth option

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

  Getter Method

  Signature `DepthOption`

  Returns: | the depth option
  Return type: | `NXOpen.CAM.ThreadTurningBuilderDepthOptionTypes`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DepthOption`

  Parameters: | depthOption (`NXOpen.CAM.ThreadTurningBuilderDepthOptionTypes`) – the depth option

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## EndLine

`ThreadTurningBuilder.``EndLine`

  Returns or sets the End Line

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

  Getter Method

  Signature `EndLine`

  Returns: | the End Line
  Return type: | `NXOpen.NXObject`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `EndLine`

  Parameters: | endLine (`NXOpen.NXObject`) – the End Line tag

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## EndOffset

`ThreadTurningBuilder.``EndOffset`

  Returns the End Offset

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

  Getter Method

  Signature `EndOffset`

  Returns: | the end offset
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX6.0.0.

  License requirements: None.

## InfeedLength

`ThreadTurningBuilder.``InfeedLength`

  Returns the infeed length

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

  Getter Method

  Signature `InfeedLength`

  Returns: | the infeed length
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX8.5.0.

  License requirements: None.

## InfeedLengthType

`ThreadTurningBuilder.``InfeedLengthType`

  Returns or sets the infeed length type

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

  Getter Method

  Signature `InfeedLengthType`

  Returns: | the infeed length type
  Return type: | `NXOpen.CAM.ThreadTurningBuilderInfeedLengthTypes`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `InfeedLengthType`

  Parameters: | infeedLengthType (`NXOpen.CAM.ThreadTurningBuilderInfeedLengthTypes`) – the infeed length type

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## InfeedMode

`ThreadTurningBuilder.``InfeedMode`

  Returns or sets the infeed mode

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

  Getter Method

  Signature `InfeedMode`

  Returns: | the infeed mode
  Return type: | `NXOpen.CAM.ThreadTurningBuilderInfeedModes`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `InfeedMode`

  Parameters: | infeedMode (`NXOpen.CAM.ThreadTurningBuilderInfeedModes`) – the infeed mode

  New in version NX8.5.0.

  License requirements: cam_base (“CAM BASE”)

## InfeedMoveAngle

`ThreadTurningBuilder.``InfeedMoveAngle`

  Returns the infeed move angle

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

  Getter Method

  Signature `InfeedMoveAngle`

  Returns: | the infeed move angle
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX8.5.0.

  License requirements: None.

## InfeedStartLineAngle

`ThreadTurningBuilder.``InfeedStartLineAngle`

  Returns the infeed start line angle

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

  Getter Method

  Signature `InfeedStartLineAngle`

  Returns: | the infeed start line angle
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX8.5.0.

  License requirements: None.

## NonCuttingBuilder

`ThreadTurningBuilder.``NonCuttingBuilder`

  Returns the non-cutting builder

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

  Getter Method

  Signature `NonCuttingBuilder`

  Returns: | the non-cutting builder
  Return type: | `NXOpen.CAM.NcmTurnThreadBuilder`

  New in version NX6.0.0.

  License requirements: None.

## RootLine

`ThreadTurningBuilder.``RootLine`

  Returns or sets the Root Line

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

  Getter Method

  Signature `RootLine`

  Returns: | the Root Line tag
  Return type: | `NXOpen.NXObject`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RootLine`

  Parameters: | rootLine (`NXOpen.NXObject`) – the Root Line tag

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## RootOffset

`ThreadTurningBuilder.``RootOffset`

  Returns the root offset

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

  Getter Method

  Signature `RootOffset`

  Returns: | the root offset
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX6.0.0.

  License requirements: None.

## StartOffset

`ThreadTurningBuilder.``StartOffset`

  Returns the Start Offset

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

  Getter Method

  Signature `StartOffset`

  Returns: | the start offset
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX6.0.0.

  License requirements: None.

## ThreadAngleBuilder

`ThreadTurningBuilder.``ThreadAngleBuilder`

  Returns the thread angle

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

  Getter Method

  Signature `ThreadAngleBuilder`

  Returns: | the thread angle
  Return type: | `NXOpen.CAM.CutAngle`

  New in version NX7.5.0.

  License requirements: None.

## TotalDepth

`ThreadTurningBuilder.``TotalDepth`

  Returns the Total Depth

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

  Getter Method

  Signature `TotalDepth`

  Returns: | the total depth
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## Validate

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