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

Represents a CAM.NcmTurnThreadBuilder
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::CAM::NcmTurnThreadBuilder:
NXOpen::CAM::NcmTurningBuilder NXOpen::CAM::NcmSubopBuilder NXOpen::CAM::BaseBuilder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  LocalReturnMainModes { LocalReturnMainModesOpstop, LocalReturnMainModesThreadPasses }
 The Local Return Main modes options
Created in NX8.5.0. More...
 
enum  LocalReturnModes { LocalReturnModesNone, LocalReturnModesNumberOfStarts, LocalReturnModesNumberOfPasses }
 The Local Return modes options
Created in NX8.5.0. More...
 
enum  LocalReturnTypes {
  LocalReturnTypesNone, LocalReturnTypesDirect, LocalReturnTypesRadialAxial, LocalReturnTypesAxialRadial,
  LocalReturnTypesClearRadialDirect, LocalReturnTypesClearAxialDirect, LocalReturnTypesClearRadial, LocalReturnTypesClearAxial,
  LocalReturnTypesRadialClearAxialDirect, LocalReturnTypesRadialAxialRadial, LocalReturnTypesRadialClearAxial, LocalReturnTypesClearRadialClearAxialDirect,
  LocalReturnTypesClearRadialAxialRadial, LocalReturnTypesClearRadialClearAxial
}
 The Cut regions type options
Created in NX6.0.0. More...
 

Public Member Functions

NXOpen::CAM::TurnThreadEngageRetractBuilderEngageBuilder ()
 Returns the Engage builder
Created in NX6.0.0. More...
 
NXOpen::CAM::PostEventsCiBuilderLocalReturnFinishGetEndEvents ()
 Returns the Local Return Finish End Events
Created in NX8.5.0. More...
 
NXOpen::CAM::PostEventsCiBuilderLocalReturnFinishGetStartEvents ()
 Returns the Local Return Finish Start Events
Created in NX8.5.0. More...
 
NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnModes LocalReturnFinishMode ()
 Returns the Local Return Finish Mode
Created in NX8.5.0. More...
 
NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnTypes LocalReturnFinishMove ()
 Returns the Local Return Finish Move
Created in NX8.5.0. More...
 
int LocalReturnFinishNumberOfPasses ()
 Returns the Local Return Finish Number of Passes
Created in NX8.5.0. More...
 
NXOpen::PointLocalReturnFinishPoint ()
 Returns the Local Return Finish Point
Created in NX8.5.0. More...
 
NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnMainModes LocalReturnMode ()
 Returns the Local Return Mode
Created in NX8.5.0. More...
 
NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnTypes LocalReturnMove ()
 Returns the Local Return Move
Created in NX6.0.0. More...
 
NXOpen::PointLocalReturnPoint ()
 Returns the Local Return Point
Created in NX6.0.0. More...
 
NXOpen::CAM::PostEventsCiBuilderLocalReturnRoughGetEndEvents ()
 Returns the Local Return Rough End Events
Created in NX8.5.0. More...
 
NXOpen::CAM::PostEventsCiBuilderLocalReturnRoughGetStartEvents ()
 Returns the Local Return Rough Start Events
Created in NX8.5.0. More...
 
NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnModes LocalReturnRoughMode ()
 Returns the Local Return Rough Mode
Created in NX8.5.0. More...
 
NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnTypes LocalReturnRoughMove ()
 Returns the Local Return Rough Move
Created in NX8.5.0. More...
 
int LocalReturnRoughNumberOfPasses ()
 Returns the Local Return Rough Number of Passes
Created in NX8.5.0. More...
 
NXOpen::PointLocalReturnRoughPoint ()
 Returns the Local Return Rough Point
Created in NX8.5.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderMinimumClearanceBuilder ()
 Returns the Minimum Clearance
Created in NX6.0.0. More...
 
int Opstops ()
 Returns the Opstops
Created in NX6.0.0. More...
 
NXOpen::CAM::TurnThreadEngageRetractBuilderRetractBuilder ()
 Returns the Retract builder
Created in NX6.0.0. More...
 
void SetLocalReturnFinishMode (NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnModes localReturnFinishMode)
 Sets the Local Return Finish Mode
Created in NX8.5.0. More...
 
void SetLocalReturnFinishMove (NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnTypes localReturnFinishMove)
 Sets the Local Return Finish Move
Created in NX8.5.0. More...
 
void SetLocalReturnFinishNumberOfPasses (int localReturnFinishNumberOfPasses)
 Sets the Local Return Finish Number of Passes
Created in NX8.5.0. More...
 
void SetLocalReturnFinishPoint (NXOpen::Point *localReturnFinishPoint)
 Sets the Local Return Finish Point
Created in NX8.5.0. More...
 
void SetLocalReturnMode (NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnMainModes localReturnMode)
 Sets the Local Return Mode
Created in NX8.5.0. More...
 
void SetLocalReturnMove (NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnTypes localMove)
 Sets the Local Return Move
Created in NX6.0.0. More...
 
void SetLocalReturnPoint (NXOpen::Point *localPoint)
 Sets the Local Return Point
Created in NX6.0.0. More...
 
void SetLocalReturnRoughMode (NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnModes localReturnRoughMode)
 Sets the Local Return Rough Mode
Created in NX8.5.0. More...
 
void SetLocalReturnRoughMove (NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnTypes localReturnRoughMove)
 Sets the Local Return Rough Move
Created in NX8.5.0. More...
 
void SetLocalReturnRoughNumberOfPasses (int localReturnRoughNumberOfPasses)
 Sets the Local Return Rough Number of Passes
Created in NX8.5.0. More...
 
void SetLocalReturnRoughPoint (NXOpen::Point *localReturnRoughPoint)
 Sets the Local Return Rough Point
Created in NX8.5.0. More...
 
void SetOpstops (int opstops)
 Sets the Opstops
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::NcmTurningBuilder
bool AvoidanceAfterLastRetract ()
 Returns the prefer direct motion after last retract
Created in NX6.0.0. More...
 
NXOpen::CAM::TurnAvoidanceApproachBuilderAvoidanceApproachBuilder ()
 Returns the approach path builder
Created in NX6.0.0. More...
 
bool AvoidanceBetweenRegions ()
 Returns the prefer direct motion between regions
Created in NX6.0.0. More...
 
NXOpen::CAM::TurnAvoidanceClearanceBuilderAvoidanceClearanceBuilder ()
 Returns the clearance builder
Created in NX6.0.0. More...
 
NXOpen::CAM::TurnAvoidanceDepartureBuilderAvoidanceDepartureBuilder ()
 Returns the departure path builder
Created in NX6.0.0. More...
 
NXOpen::CAM::TurnAvoidanceFromBuilderAvoidanceFromBuilder ()
 Returns the avoidance from builder
Created in NX6.0.0. More...
 
NXOpen::CAM::TurnAvoidanceGohomeBuilderAvoidanceGohomeBuilder ()
 Returns the gohome point builder
Created in NX6.0.0. More...
 
NXOpen::CAM::TurnAvoidanceReturnBuilderAvoidanceReturnBuilder ()
 Returns the return path builder
Created in NX6.0.0. More...
 
NXOpen::CAM::TurnAvoidanceStartBuilderAvoidanceStartBuilder ()
 Returns the avoidance start builder
Created in NX6.0.0. More...
 
NXOpen::CAM::TurnAvoidanceStartOfEngageBuilderAvoidanceStartOfEngageBuilder ()
 Returns the start of engage builder
Created in NX6.0.0. More...
 
bool AvoidanceToStartOfEngage ()
 Returns the prefer direct motion to start of engage
Created in NX6.0.0. More...
 
NXOpen::CAM::CutcomCutcom ()
 Returns the cutter compensation builder
Created in NX6.0.2. More...
 
NXOpen::CAM::NcmHoleMachiningNcmHoleMachiningBuilder ()
 Returns the non cutting moves hole machining builder
Created in NX10.0.2. More...
 
void SetAvoidanceAfterLastRetract (bool avoidanceAfterLastRetract)
 Sets the prefer direct motion after last retract
Created in NX6.0.0. More...
 
void SetAvoidanceBetweenRegions (bool avoidanceBetweenRegions)
 Sets the prefer direct motion between regions
Created in NX6.0.0. More...
 
void SetAvoidanceToStartOfEngage (bool avoidanceToStartOfEngage)
 Sets the prefer direct motion to start of engage
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::NcmSubopBuilder
NXOpen::CAM::NcmSubopBuilder::DefaultRegionStartTypes DefaultRegionStartType ()
 Returns the region start type
Created in NX8.5.0. More...
 
void GetRegionStartPoints (std::vector< NXOpen::Point * > &regionStartPoints)
 Returns region start points
Created in NX8.5.0. More...
 
void SetDefaultRegionStartType (NXOpen::CAM::NcmSubopBuilder::DefaultRegionStartTypes defaultRegionStartType)
 Sets the region start type
Created in NX8.5.0. More...
 
void SetRegionStartPoints (const std::vector< NXOpen::Point * > &regionStartPoints)
 Sets region start points
Created in NX8.5.0. More...
 
void SetStartPointsUseEffectDist (bool newValue)
 Sets the start points use effective distance
Created in NX8.5.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderStartPointsEffectDistBuilder ()
 Returns the region start points effective distance builder (inheritable tool dep)
Created in NX8.5.0. More...
 
bool StartPointsUseEffectDist ()
 Returns the start points use effective distance
Created in NX8.5.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::BaseBuilder
NXOpen::TaggedObjectGetCustomizableItemBuilder (const NXString &name)
 Returns the customizable item builder for given customizable item name. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const char *name)
 Returns the customizable item builder for given customizable item name. More...
 
std::vector< NXStringGetCustomizableItemNames ()
 Returns the names for all customizable item ids. 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 CAM.NcmTurnThreadBuilder
Created in NX6.0.0.


Member Enumeration Documentation

The Local Return Main modes options
Created in NX8.5.0.


Enumerator
LocalReturnMainModesOpstop 

Opstop.

LocalReturnMainModesThreadPasses 

Thread Passes.

The Local Return modes options
Created in NX8.5.0.


Enumerator
LocalReturnModesNone 

None.

LocalReturnModesNumberOfStarts 

Number of Starts.

LocalReturnModesNumberOfPasses 

Number of Passes.

The Cut regions type options
Created in NX6.0.0.


Enumerator
LocalReturnTypesNone 

None.

LocalReturnTypesDirect 

Direct.

LocalReturnTypesRadialAxial 

Radial-Axial.

LocalReturnTypesAxialRadial 

Axial-Radial.

LocalReturnTypesClearRadialDirect 

Clear Radial-Direct.

LocalReturnTypesClearAxialDirect 

Clear Axial-Direct.

LocalReturnTypesClearRadial 

Clear Radial.

LocalReturnTypesClearAxial 

Clear Axial.

LocalReturnTypesRadialClearAxialDirect 

Radial-Clear Axial-Direct.

LocalReturnTypesRadialAxialRadial 

Radial-Axial-Radial.

LocalReturnTypesRadialClearAxial 

Radial-Clear Axial.

LocalReturnTypesClearRadialClearAxialDirect 

Clear Radial-Clear Axial-Direct.

LocalReturnTypesClearRadialAxialRadial 

Clear Radial-Axial-Radial.

LocalReturnTypesClearRadialClearAxial 

Clear Radial-Clear Axial.

Member Function Documentation

NXOpen::CAM::TurnThreadEngageRetractBuilder* NXOpen::CAM::NcmTurnThreadBuilder::EngageBuilder ( )

Returns the Engage builder
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::PostEventsCiBuilder* NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnFinishGetEndEvents ( )

Returns the Local Return Finish End Events
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::PostEventsCiBuilder* NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnFinishGetStartEvents ( )

Returns the Local Return Finish Start Events
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnModes NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnFinishMode ( )

Returns the Local Return Finish Mode
Created in NX8.5.0.



License requirements : None

NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnTypes NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnFinishMove ( )

Returns the Local Return Finish Move
Created in NX8.5.0.



License requirements : None

int NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnFinishNumberOfPasses ( )

Returns the Local Return Finish Number of Passes
Created in NX8.5.0.



License requirements : None

NXOpen::Point* NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnFinishPoint ( )

Returns the Local Return Finish Point
Created in NX8.5.0.



License requirements : None

NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnMainModes NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnMode ( )

Returns the Local Return Mode
Created in NX8.5.0.



License requirements : None

NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnTypes NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnMove ( )

Returns the Local Return Move
Created in NX6.0.0.



License requirements : None

NXOpen::Point* NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnPoint ( )

Returns the Local Return Point
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::PostEventsCiBuilder* NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnRoughGetEndEvents ( )

Returns the Local Return Rough End Events
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::PostEventsCiBuilder* NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnRoughGetStartEvents ( )

Returns the Local Return Rough Start Events
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnModes NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnRoughMode ( )

Returns the Local Return Rough Mode
Created in NX8.5.0.



License requirements : None

NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnTypes NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnRoughMove ( )

Returns the Local Return Rough Move
Created in NX8.5.0.



License requirements : None

int NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnRoughNumberOfPasses ( )

Returns the Local Return Rough Number of Passes
Created in NX8.5.0.



License requirements : None

NXOpen::Point* NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnRoughPoint ( )

Returns the Local Return Rough Point
Created in NX8.5.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::NcmTurnThreadBuilder::MinimumClearanceBuilder ( )

Returns the Minimum Clearance
Created in NX6.0.0.



License requirements : None

int NXOpen::CAM::NcmTurnThreadBuilder::Opstops ( )

Returns the Opstops
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::TurnThreadEngageRetractBuilder* NXOpen::CAM::NcmTurnThreadBuilder::RetractBuilder ( )

Returns the Retract builder
Created in NX6.0.0.



License requirements : None

void NXOpen::CAM::NcmTurnThreadBuilder::SetLocalReturnFinishMode ( NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnModes  localReturnFinishMode)

Sets the Local Return Finish Mode
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
localReturnFinishModethe Local Return Finish Mode
void NXOpen::CAM::NcmTurnThreadBuilder::SetLocalReturnFinishMove ( NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnTypes  localReturnFinishMove)

Sets the Local Return Finish Move
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
localReturnFinishMovethe Local Return Finish Move
void NXOpen::CAM::NcmTurnThreadBuilder::SetLocalReturnFinishNumberOfPasses ( int  localReturnFinishNumberOfPasses)

Sets the Local Return Finish Number of Passes
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
localReturnFinishNumberOfPassesthe Local Return Finish Number of Passes
void NXOpen::CAM::NcmTurnThreadBuilder::SetLocalReturnFinishPoint ( NXOpen::Point localReturnFinishPoint)

Sets the Local Return Finish Point
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
localReturnFinishPointthe Local Return Finish Point
void NXOpen::CAM::NcmTurnThreadBuilder::SetLocalReturnMode ( NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnMainModes  localReturnMode)

Sets the Local Return Mode
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
localReturnModethe Local Return Main Mode
void NXOpen::CAM::NcmTurnThreadBuilder::SetLocalReturnMove ( NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnTypes  localMove)

Sets the Local Return Move
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
localMovethe Local Return Move
void NXOpen::CAM::NcmTurnThreadBuilder::SetLocalReturnPoint ( NXOpen::Point localPoint)

Sets the Local Return Point
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
localPointthe Local Return Point
void NXOpen::CAM::NcmTurnThreadBuilder::SetLocalReturnRoughMode ( NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnModes  localReturnRoughMode)

Sets the Local Return Rough Mode
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
localReturnRoughModethe Local Return Rough Mode
void NXOpen::CAM::NcmTurnThreadBuilder::SetLocalReturnRoughMove ( NXOpen::CAM::NcmTurnThreadBuilder::LocalReturnTypes  localReturnRoughMove)

Sets the Local Return Rough Move
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
localReturnRoughMovethe Local Return Rough Move
void NXOpen::CAM::NcmTurnThreadBuilder::SetLocalReturnRoughNumberOfPasses ( int  localReturnRoughNumberOfPasses)

Sets the Local Return Rough Number of Passes
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
localReturnRoughNumberOfPassesthe Local Return Rough Number of Passes
void NXOpen::CAM::NcmTurnThreadBuilder::SetLocalReturnRoughPoint ( NXOpen::Point localReturnRoughPoint)

Sets the Local Return Rough Point
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
localReturnRoughPointthe Local Return Rough Point
void NXOpen::CAM::NcmTurnThreadBuilder::SetOpstops ( int  opstops)

Sets the Opstops
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
opstopsthe Opstops

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