NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAM::ThreadTurningBuilder Class Reference

Represents a ThreadTurning Builder
To create a new instance of this class, use NXOpen::CAM::OperationCollection::CreateThreadTurningBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::CAM::ThreadTurningBuilder:
NXOpen::CAM::TurningOperationBuilder NXOpen::CAM::OperationBuilder NXOpen::CAM::ParamBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DepthOptionTypes { DepthOptionTypesRootLine, DepthOptionTypesDepthAndAngle }
 the Depth Option types More...
 
enum  InfeedLengthTypes { InfeedLengthTypesAuto, InfeedLengthTypesSpecify }
 the Infeed Length Types More...
 
enum  InfeedModes { InfeedModesNone, InfeedModesAuto, InfeedModesSpecify }
 the Infeed modes More...
 
- Public Types inherited from NXOpen::CAM::TurningOperationBuilder
enum  MotionOutputOptions { MotionOutputOptionsLinearOnly, MotionOutputOptionsCircular, MotionOutputOptionsMachineCycle }
 The motion output options
Created in NX6.0.0. More...
 
enum  ReorientToolHolderModeOptions { ReorientToolHolderModeOptionsNone, ReorientToolHolderModeOptionsFixed, ReorientToolHolderModeOptionsVariable }
 available options for Reorient Tool Holder Mode More...
 
enum  TrackingPointType { TrackingPointTypeFixed, TrackingPointTypeRotate, TrackingPointTypeAuto }
 available types for tracking point More...
 
- Public Types inherited from NXOpen::CAM::OperationBuilder
enum  HoleAxisTypes { HoleAxisTypesVector, HoleAxisTypesRule, HoleAxisTypesRuleIfNoVector }
 Available types for Hole Axis Type in feature milling and hole making. More...
 
enum  HoleDepthTypes { HoleDepthTypesPoint, HoleDepthTypesRule }
 Available types for Hole Depth Type in feature milling and hole making. More...
 
enum  OptimizationBasedOnTypes { OptimizationBasedOnTypesDist, OptimizationBasedOnTypesOrient }
 Available types for optimization based on in operation. More...
 
enum  OptimizationDistanceTypes { OptimizationDistanceTypesDirect, OptimizationDistanceTypesTransition }
 Available types for optimization distance method in operation. More...
 
enum  OptimizationLevelTypes { OptimizationLevelTypesStandard, OptimizationLevelTypesAdvanced }
 Available types for optimization level in operation. More...
 
- Public Types inherited from NXOpen::CAM::ParamBuilder
enum  OptimizationTypes { OptimizationTypesNone, OptimizationTypesMinimizeTravel, OptimizationTypesBand }
 Available types for Optimization Method in operation. More...
 

Public Member Functions

NXOpen::NXObjectCrestLine ()
 Returns the Crest Line
Created in NX6.0.0. More...
 
bool CrestLineDirection ()
 Returns the Crest Line Direction(Start and End Points)
Created in NX6.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderCrestOffset ()
 Returns the crest offset builder
Created in NX6.0.0. More...
 
NXOpen::CAM::ThreadCutParametersCutParameters ()
 Returns the cut parameter object
Created in NX6.0.0. More...
 
NXOpen::CAM::ThreadTurningBuilder::DepthOptionTypes DepthOption ()
 Returns the depth option
Created in NX6.0.0. More...
 
NXOpen::NXObjectEndLine ()
 Returns the End Line
Created in NX6.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderEndOffset ()
 Returns the End Offset
Created in NX6.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderInfeedLength ()
 Returns the infeed length
Created in NX8.5.0. More...
 
NXOpen::CAM::ThreadTurningBuilder::InfeedLengthTypes InfeedLengthType ()
 Returns the infeed length type
Created in NX8.5.0. More...
 
NXOpen::CAM::ThreadTurningBuilder::InfeedModes InfeedMode ()
 Returns the infeed mode
Created in NX8.5.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderInfeedMoveAngle ()
 Returns the infeed move angle
Created in NX8.5.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderInfeedStartLineAngle ()
 Returns the infeed start line angle
Created in NX8.5.0. More...
 
NXOpen::CAM::NcmTurnThreadBuilderNonCuttingBuilder ()
 Returns the non-cutting builder
Created in NX6.0.0. More...
 
NXOpen::NXObjectRootLine ()
 Returns the Root Line
Created in NX6.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderRootOffset ()
 Returns the root offset
Created in NX6.0.0. More...
 
void SetCrestLine (NXOpen::NXObject *crestLine)
 Sets the Crest Line
Created in NX6.0.0. More...
 
void SetCrestLineDirection (bool crestLineDirection)
 Sets the Crest Line Direction(Start and End Points)
Created in NX6.0.0. More...
 
void SetDepthOption (NXOpen::CAM::ThreadTurningBuilder::DepthOptionTypes depthOption)
 Sets the depth option
Created in NX6.0.0. More...
 
void SetEndLine (NXOpen::NXObject *endLine)
 Sets the End Line
Created in NX6.0.0. More...
 
void SetInfeedLengthType (NXOpen::CAM::ThreadTurningBuilder::InfeedLengthTypes infeedLengthType)
 Sets the infeed length type
Created in NX8.5.0. More...
 
void SetInfeedMode (NXOpen::CAM::ThreadTurningBuilder::InfeedModes infeedMode)
 Sets the infeed mode
Created in NX8.5.0. More...
 
void SetRootLine (NXOpen::NXObject *rootLine)
 Sets the Root Line
Created in NX6.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderStartOffset ()
 Returns the Start Offset
Created in NX6.0.0. More...
 
NXOpen::CAM::CutAngleThreadAngleBuilder ()
 Returns the thread angle
Created in NX7.5.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderTotalDepth ()
 Returns the Total Depth
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::TurningOperationBuilder
NXString AdditionalCommands ()
 Returns the Additional Commands
Created in NX6.0.0. More...
 
NXOpen::CAM::FeedsTurnBuilderFeedsBuilder ()
 Returns the feeds and speeds builder
Created in NX6.0.0. More...
 
bool FlipToolAroundHolder ()
 Returns the Flip Tool Around Holder toggle
Created in NX6.0.0. More...
 
NXString MachineCycleSubroutineName ()
 Returns the machine cycle subroutine name
Created in NX8.0.0. More...
 
NXOpen::CAM::TurningOperationBuilder::MotionOutputOptions MotionOutput ()
 Returns the motion output
Created in NX6.0.0. More...
 
bool ReorientToolHolder ()
 Returns the Reorient Tool Holder toggle. More...
 
NXOpen::CAM::TurningOperationBuilder::ReorientToolHolderModeOptions ReorientToolHolderMode ()
 Returns the Reorient Tool Holder Mode
Created in NX11.0.0. More...
 
bool RotateTrackingPoint ()
 Returns the Rotate Tracking Point toggle
More...
 
void SetAdditionalCommands (const NXString &additionalCommands)
 Sets the Additional Commands
Created in NX6.0.0. More...
 
void SetAdditionalCommands (const char *additionalCommands)
 Sets the Additional Commands
Created in NX6.0.0. More...
 
void SetFlipToolAroundHolder (bool machAAxis)
 Sets the Flip Tool Around Holder toggle
Created in NX6.0.0. More...
 
void SetMachineCycleSubroutineName (const NXString &machineCycleSubroutineName)
 Sets the machine cycle subroutine name
Created in NX8.0.0. More...
 
void SetMachineCycleSubroutineName (const char *machineCycleSubroutineName)
 Sets the machine cycle subroutine name
Created in NX8.0.0. More...
 
void SetMotionOutput (NXOpen::CAM::TurningOperationBuilder::MotionOutputOptions motionOutput)
 Sets the motion output
Created in NX6.0.0. More...
 
void SetReorientToolHolder (bool reorient)
 Sets the Reorient Tool Holder toggle. More...
 
void SetReorientToolHolderMode (NXOpen::CAM::TurningOperationBuilder::ReorientToolHolderModeOptions reorientToolHolderMode)
 Sets the Reorient Tool Holder Mode
Created in NX11.0.0. More...
 
void SetRotateTrackingPoint (bool rotate)
 Sets the Rotate Tracking Point toggle
More...
 
void SetTrackingPointStatus (NXOpen::CAM::TurningOperationBuilder::TrackingPointType status)
 Sets the tracking point status
Created in NX8.5.0. More...
 
void SetUpdateIpw (bool updateIpwMode)
 Sets the update IPW mode
Created in NX6.0.0. More...
 
void SetUseMachineCycle (bool machineCycle)
 Sets the Use Machine Cycle toggle
Created in NX6.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderToolHolderAngle ()
 Returns the Tool Holder Angle
Created in NX6.0.0. More...
 
NXOpen::CAM::TurningOperationBuilder::TrackingPointType TrackingPointStatus ()
 Returns the tracking point status
Created in NX8.5.0. More...
 
bool UpdateIpw ()
 Returns the update IPW mode
Created in NX6.0.0. More...
 
bool UseMachineCycle ()
 Returns the Use Machine Cycle toggle
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::OperationBuilder
NXString ChannelName ()
 Returns the channel's name
Created in NX7.5.0. More...
 
NXString Description ()
 Returns the description
Created in NX9.0.0. More...
 
NXOpen::CAM::PostEventsCiBuilderEndOfPath ()
 Returns the end event builder
Created in NX5.0.1. More...
 
NXOpen::CAM::UdeSetEndUdeSet ()
 Returns the end ude set
Created in NX7.5.0. More...
 
NXOpen::CAM::GeometryCiBuilderGeometry ()
 Returns the geometry builder
Created in NX5.0.0. More...
 
std::vector< double > GetHoleAxisValues ()
 Get the Hole Axis values. More...
 
bool GougeChecking ()
 Returns the gouge checking flag
Created in NX9.0.0. More...
 
NXOpen::CAM::OperationBuilder::HoleAxisTypes HoleAxisType ()
 Returns the Hole Axis Type
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderHoleDepth ()
 Returns the max depth distance builder
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationBuilder::HoleDepthTypes HoleDepthType ()
 Returns the Hole Depth Type
Created in NX5.0.0. More...
 
NXOpen::CAM::LayoutCiBuilderLayoutAndLayer ()
 Returns the Layer and Layout
Created in NX9.0.1. More...
 
NXOpen::CAM::ArcOutputTypeCiBuilderMotionOutputBuilder ()
 Returns the motion output builder
Created in NX8.0.0. More...
 
NXOpen::CAM::NotesNotes ()
 Returns the notes builder
Created in NX9.0.0. More...
 
NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes OptimizationBasedOn ()
 Returns the optimization based on in operation
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes OptimizationDistanceMethod ()
 Returns the optimization distance method in operation
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationBuilder::OptimizationLevelTypes OptimizationLevel ()
 Returns the optimization level in operation
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationDisplayOptionsBuilderPathDisplayOptions ()
 Returns the path display options builder
Created in NX6.0.0. More...
 
NXString PostToolPathExit ()
 Returns the environment variable that points to the post tool path generation library which has the exit
Created in NX9.0.3. More...
 
NXOpen::CAM::InheritableDoubleBuilderRetractDistance ()
 Returns the Retract Distance builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderRetractDistanceOnToolAxisChange ()
 Returns the Retract Distance on Tool Axis Change builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderSafeClearance ()
 Returns the safe clearance builder
Created in NX6.0.0. More...
 
bool SelectToolFlag ()
 Returns the user selected tool
Created in NX5.0.0. More...
 
void SetChannelName (const NXString &channel)
 Sets the channel's name
Created in NX7.5.0. More...
 
void SetChannelName (const char *channel)
 Sets the channel's name
Created in NX7.5.0. More...
 
void SetDescription (const NXString &description)
 Sets the description
Created in NX9.0.0. More...
 
void SetDescription (const char *description)
 Sets the description
Created in NX9.0.0. More...
 
void SetGougeChecking (bool gougeChecking)
 Sets the gouge checking flag
Created in NX9.0.0. More...
 
void SetHoleAxisType (NXOpen::CAM::OperationBuilder::HoleAxisTypes types)
 Sets the Hole Axis Type
Created in NX5.0.0. More...
 
void SetHoleAxisValues (const std::vector< double > &holeAxis)
 Set the Hole Axis values
Created in NX5.0.0. More...
 
void SetHoleDepthType (NXOpen::CAM::OperationBuilder::HoleDepthTypes types)
 Sets the Hole Depth Type
Created in NX5.0.0. More...
 
void SetOptimizationBasedOn (NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes optimBasedOn)
 Sets the optimization based on in operation
Created in NX5.0.0. More...
 
void SetOptimizationDistanceMethod (NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes optimDistance)
 Sets the optimization distance method in operation
Created in NX5.0.0. More...
 
void SetOptimizationLevel (NXOpen::CAM::OperationBuilder::OptimizationLevelTypes optimType)
 Sets the optimization level in operation
Created in NX5.0.0. More...
 
void SetPostToolPathExit (const NXString &exitName)
 Sets the environment variable that points to the post tool path generation library which has the exit
Created in NX9.0.3. More...
 
void SetPostToolPathExit (const char *exitName)
 Sets the environment variable that points to the post tool path generation library which has the exit
Created in NX9.0.3. More...
 
void SetSelectToolFlag (bool selToolFlag)
 Sets the user selected tool
Created in NX5.0.0. More...
 
NXOpen::CAM::PostEventsCiBuilderStartOfPath ()
 Returns the start event builder
Created in NX5.0.1. More...
 
NXOpen::CAM::UdeSetStartUdeSet ()
 Returns the start ude set
Created in NX7.5.0. More...
 
NXOpen::CAM::ToolChangeCiBuilderToolChangeSetting ()
 Returns the tool change builder
Created in NX5.0.0. More...
 
NXOpen::CAM::ToolPathEditorBuilderToolPathEditor ()
 Returns the Tool Path Editor Builder
Created in NX9.0.3. More...
 
NXOpen::CAM::ToolPathSplitParametersBuilderToolPathSplitParametersBuilder ()
 Returns the tool path split Parameters
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::ParamBuilder
NXOpen::CAM::UdeCycleEvent ()
 Returns the cycle event
Created in NX7.5.0. More...
 
NXOpen::CAM::CycleCycleTable ()
 Returns the cycle
Created in NX9.0.0. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const NXString &name)
 Returns the customizable item builder for the given customizable item name. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const char *name)
 Returns the customizable item builder for the given customizable item name. More...
 
std::vector< NXStringGetCustomizableItemNames ()
 Returns the names for all customizable item ids. More...
 
NXOpen::CAM::ParamBuilder::OptimizationTypes OptimizationMethod ()
 Returns the optim method
Created in NX5.0.0. More...
 
void SetOptimizationMethod (NXOpen::CAM::ParamBuilder::OptimizationTypes optimMethod)
 Sets the optim method
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a ThreadTurning Builder
To create a new instance of this class, use NXOpen::CAM::OperationCollection::CreateThreadTurningBuilder

Created in NX6.0.0.


Member Enumeration Documentation

the Depth Option types

Enumerator
DepthOptionTypesRootLine 

Root Line.

DepthOptionTypesDepthAndAngle 

Depth and Angle.

the Infeed Length Types

Enumerator
InfeedLengthTypesAuto 

Auto.

InfeedLengthTypesSpecify 

Specify.

the Infeed modes

Enumerator
InfeedModesNone 

None.

InfeedModesAuto 

Auto.

InfeedModesSpecify 

Specify.

Member Function Documentation

NXOpen::NXObject* NXOpen::CAM::ThreadTurningBuilder::CrestLine ( )

Returns the Crest Line
Created in NX6.0.0.



License requirements : None

bool NXOpen::CAM::ThreadTurningBuilder::CrestLineDirection ( )

Returns the Crest Line Direction(Start and End Points)
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::ThreadTurningBuilder::CrestOffset ( )

Returns the crest offset builder
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::ThreadCutParameters* NXOpen::CAM::ThreadTurningBuilder::CutParameters ( )

Returns the cut parameter object
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::ThreadTurningBuilder::DepthOptionTypes NXOpen::CAM::ThreadTurningBuilder::DepthOption ( )

Returns the depth option
Created in NX6.0.0.



License requirements : None

NXOpen::NXObject* NXOpen::CAM::ThreadTurningBuilder::EndLine ( )

Returns the End Line
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::ThreadTurningBuilder::EndOffset ( )

Returns the End Offset
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::ThreadTurningBuilder::InfeedLength ( )

Returns the infeed length
Created in NX8.5.0.



License requirements : None

NXOpen::CAM::ThreadTurningBuilder::InfeedLengthTypes NXOpen::CAM::ThreadTurningBuilder::InfeedLengthType ( )

Returns the infeed length type
Created in NX8.5.0.



License requirements : None

NXOpen::CAM::ThreadTurningBuilder::InfeedModes NXOpen::CAM::ThreadTurningBuilder::InfeedMode ( )

Returns the infeed mode
Created in NX8.5.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::ThreadTurningBuilder::InfeedMoveAngle ( )

Returns the infeed move angle
Created in NX8.5.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::ThreadTurningBuilder::InfeedStartLineAngle ( )

Returns the infeed start line angle
Created in NX8.5.0.



License requirements : None

NXOpen::CAM::NcmTurnThreadBuilder* NXOpen::CAM::ThreadTurningBuilder::NonCuttingBuilder ( )

Returns the non-cutting builder
Created in NX6.0.0.



License requirements : None

NXOpen::NXObject* NXOpen::CAM::ThreadTurningBuilder::RootLine ( )

Returns the Root Line
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::ThreadTurningBuilder::RootOffset ( )

Returns the root offset
Created in NX6.0.0.



License requirements : None

void NXOpen::CAM::ThreadTurningBuilder::SetCrestLine ( NXOpen::NXObject crestLine)

Sets the Crest Line
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
crestLinethe Crest Line tag
void NXOpen::CAM::ThreadTurningBuilder::SetCrestLineDirection ( bool  crestLineDirection)

Sets the Crest Line Direction(Start and End Points)
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
crestLineDirectionthe Crest Line Direction tag
void NXOpen::CAM::ThreadTurningBuilder::SetDepthOption ( NXOpen::CAM::ThreadTurningBuilder::DepthOptionTypes  depthOption)

Sets the depth option
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
depthOptionthe depth option
void NXOpen::CAM::ThreadTurningBuilder::SetEndLine ( NXOpen::NXObject endLine)

Sets the End Line
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
endLinethe End Line tag
void NXOpen::CAM::ThreadTurningBuilder::SetInfeedLengthType ( NXOpen::CAM::ThreadTurningBuilder::InfeedLengthTypes  infeedLengthType)

Sets the infeed length type
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
infeedLengthTypethe infeed length type
void NXOpen::CAM::ThreadTurningBuilder::SetInfeedMode ( NXOpen::CAM::ThreadTurningBuilder::InfeedModes  infeedMode)

Sets the infeed mode
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
infeedModethe infeed mode
void NXOpen::CAM::ThreadTurningBuilder::SetRootLine ( NXOpen::NXObject rootLine)

Sets the Root Line
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
rootLinethe Root Line tag
NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::ThreadTurningBuilder::StartOffset ( )

Returns the Start Offset
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::CutAngle* NXOpen::CAM::ThreadTurningBuilder::ThreadAngleBuilder ( )

Returns the thread angle
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::ThreadTurningBuilder::TotalDepth ( )

Returns the Total Depth
Created in NX6.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.