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

Represents a Turning tool builder
This is an abstract class, and cannot be instantiated. More...

Inheritance diagram for NXOpen::CAM::TurningToolBuilder:
NXOpen::CAM::ToolBuilder NXOpen::CAM::NCGroupBuilder NXOpen::CAM::ParamBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::CAM::FormToolBuilder NXOpen::CAM::GrooveToolBuilder NXOpen::CAM::ThreadToolBuilder NXOpen::CAM::TurnToolBuilder

Public Types

enum  HolderShankTypes { HolderShankTypesSquare, HolderShankTypesRound }
 the available turn holder shank types More...
 
enum  InsertPositions { InsertPositionsTopside, InsertPositionsUnderside }
 the available insert positions More...
 

Public Member Functions

NXOpen::CAM::InheritableDoubleBuilderHolderAngleBuilder ()
 Returns the holder angle builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderHolderLengthBuilder ()
 Returns the turn holder length builder (inheritable double)
Created in NX5.0.0. More...
 
bool HolderLock ()
 Returns the lock turn holder toggle
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderHolderShankLineBuilder ()
 Returns the turn holder shank line builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::TurningToolBuilder::HolderShankTypes HolderShankType ()
 Returns the turn holder shank type
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderHolderShankWidthBuilder ()
 Returns the turn holder shank width builder (inheritable double)
Created in NX5.0.0. More...
 
bool HolderUse ()
 Returns the use turn holder toggle
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderHolderWidthBuilder ()
 Returns the turn holder width builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderInsertLengthBuilder ()
 Returns the insert length builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::TurningToolBuilder::InsertPositions InsertPosition ()
 Returns the insert position
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderInsertWidthBuilder ()
 Returns the insert width builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderLeftAngleBuilder ()
 Returns the left angle builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::ManageToolPartBuilderManageToolPartBuilder ()
 Returns the manage tool part builder
Created in NX6.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderMaxDepthBuilder ()
 Returns the max. More...
 
bool MaxDepthToggle ()
 Returns the max. More...
 
NXOpen::CAM::InheritableDoubleBuilderMaxFacingDiameterBuilder ()
 Returns the max. More...
 
bool MaxFacingDiameterToggle ()
 Returns the max. More...
 
NXOpen::CAM::InheritableDoubleBuilderMaxToolReachBuilder ()
 Returns the max. More...
 
bool MaxToolReachToggle ()
 Returns the max. More...
 
NXOpen::CAM::NCGroupMcsSpindleGroup ()
 Returns the MCS spindle group
Created in NX7.5.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderMinBoringDiameterBuilder ()
 Returns the min. More...
 
bool MinBoringDiameterToggle ()
 Returns the min. More...
 
NXOpen::CAM::InheritableDoubleBuilderMinFacingDiameterBuilder ()
 Returns the min. More...
 
bool MinFacingDiameterToggle ()
 Returns the min. More...
 
NXOpen::CAM::InheritableDoubleBuilderNoseRadiusBuilder ()
 Returns the nose radius builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderNoseWidthBuilder ()
 Returns the nose width builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderOrientAngleBuilder ()
 Returns the orient angle builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderRightAngleBuilder ()
 Returns the right angle builder (inheritable double)
Created in NX5.0.0. More...
 
void SetHolderLock (bool holderLock)
 Sets the lock turn holder toggle
Created in NX5.0.0. More...
 
void SetHolderShankType (NXOpen::CAM::TurningToolBuilder::HolderShankTypes holderShankType)
 Sets the turn holder shank type
Created in NX5.0.0. More...
 
void SetHolderUse (bool holderUse)
 Sets the use turn holder toggle
Created in NX5.0.0. More...
 
void SetInsertPosition (NXOpen::CAM::TurningToolBuilder::InsertPositions insertPosition)
 Sets the insert position
Created in NX5.0.0. More...
 
void SetMaxDepthToggle (bool maxDepthToggle)
 Sets the max. More...
 
void SetMaxFacingDiameterToggle (bool maxFacingDiameterToggle)
 Sets the max. More...
 
void SetMaxToolReachToggle (bool maxToolReachToggle)
 Sets the max. More...
 
void SetMcsSpindleGroup (NXOpen::CAM::NCGroup *mcsSpindleGroup)
 Sets the MCS spindle group
Created in NX7.5.0. More...
 
void SetMinBoringDiameterToggle (bool minBoringDiameterToggle)
 Sets the min. More...
 
void SetMinFacingDiameterToggle (bool minFacingDiameterToggle)
 Sets the min. More...
 
NXOpen::CAM::InheritableDoubleBuilderThicknessBuilder ()
 Returns the thickness builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::TrackingBuilderTrackingBuilder ()
 Returns the tracking point builder
Created in NX5.0.1. More...
 
NXOpen::CAM::InheritableDoubleBuilderXMountBuilder ()
 Returns the x mount builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderYMountBuilder ()
 Returns the y mount builder (inheritable double)
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::ToolBuilder
NXString ChannelName ()
 Returns the channel's name
Created in NX7.5.0. More...
 
NXOpen::CAM::CutterExportCutterExportBuilder ()
 Returns the cutter export builder
Created in NX9.0.1. More...
 
NXString GetMaterial ()
 Get tool material. More...
 
void GetMaterialData (NXString *libRef, NXString *name, NXString *description, NXString *code)
 Get material data
Created in NX8.0.2. More...
 
NXString HolderDescription ()
 Returns the holder description
Created in NX7.5.1. More...
 
NXString HolderLibraryReference ()
 Returns the holder libref
Created in NX7.5.1. More...
 
NXOpen::CAM::UdeLibraryParametersBuilder ()
 Returns the Library Data Object
Created in NX9.0.0. More...
 
void SetChannelName (const NXString &name)
 Sets the channel's name
Created in NX7.5.0. More...
 
void SetChannelName (const char *name)
 Sets the channel's name
Created in NX7.5.0. More...
 
void SetHolderDescription (const NXString &holderDescriptionValue)
 Sets the holder description
Created in NX7.5.1. More...
 
void SetHolderDescription (const char *holderDescriptionValue)
 Sets the holder description
Created in NX7.5.1. More...
 
void SetHolderLibraryReference (const NXString &holderLibrefValue)
 Sets the holder libref
Created in NX7.5.1. More...
 
void SetHolderLibraryReference (const char *holderLibrefValue)
 Sets the holder libref
Created in NX7.5.1. More...
 
void SetMaterial (const NXString &libRef)
 Set tool material
Created in NX8.0.1. More...
 
void SetMaterial (const char *libRef)
 Set tool material
Created in NX8.0.1. More...
 
void SetTlCtlgNum (const NXString &tlCtlgNumValue)
 Sets the Catalog Number
Created in NX5.0.0. More...
 
void SetTlCtlgNum (const char *tlCtlgNumValue)
 Sets the Catalog Number
Created in NX5.0.0. More...
 
void SetTlDescription (const NXString &tlDescriptionValue)
 Sets the Cutter Description
Created in NX5.0.0. More...
 
void SetTlDescription (const char *tlDescriptionValue)
 Sets the Cutter Description
Created in NX5.0.0. More...
 
void SetTlLibref (const NXString &tlLibRef)
 Sets the Cutter Libref
Created in NX5.0.0. More...
 
void SetTlLibref (const char *tlLibRef)
 Sets the Cutter Libref
Created in NX5.0.0. More...
 
void SetTlManualToolChange (bool tlManualToolChangeValue)
 Sets the Manual Tool Change
Created in NX5.0.0. More...
 
void SetTlText (const NXString &tlText)
 Sets the tool text
Created in NX5.0.0. More...
 
void SetTlText (const char *tlText)
 Sets the tool text
Created in NX5.0.0. More...
 
NXString TlCtlgNum ()
 Returns the Catalog Number
Created in NX5.0.0. More...
 
NXString TlDescription ()
 Returns the Cutter Description
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableIntBuilderTlHolderNumberBuilder ()
 Returns the Holder Number
Created in NX5.0.0. More...
 
NXString TlLibref ()
 Returns the Cutter Libref
Created in NX5.0.0. More...
 
bool TlManualToolChange ()
 Returns the Manual Tool Change
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableIntBuilderTlNumberBuilder ()
 Returns the Tool Number
Created in NX5.0.0. More...
 
NXString TlText ()
 Returns the tool text
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::NCGroupBuilder
NXString Description ()
 Returns the description
Created in NX9.0.0. More...
 
NXOpen::CAM::UdeSetEndUdeSet ()
 Returns the end ude set
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...
 
NXOpen::CAM::UdeSetStartUdeSet ()
 Returns the start ude set
Created in NX7.5.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 Turning tool builder
This is an abstract class, and cannot be instantiated.



Created in NX5.0.0.

Member Enumeration Documentation

the available turn holder shank types

Enumerator
HolderShankTypesSquare 

Square Shank.

HolderShankTypesRound 

Round Shank.

the available insert positions

Enumerator
InsertPositionsTopside 

Topside.

InsertPositionsUnderside 

Underside.

Member Function Documentation

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::HolderAngleBuilder ( )

Returns the holder angle builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::HolderLengthBuilder ( )

Returns the turn holder length builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

bool NXOpen::CAM::TurningToolBuilder::HolderLock ( )

Returns the lock turn holder toggle
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::HolderShankLineBuilder ( )

Returns the turn holder shank line builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::TurningToolBuilder::HolderShankTypes NXOpen::CAM::TurningToolBuilder::HolderShankType ( )

Returns the turn holder shank type
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::HolderShankWidthBuilder ( )

Returns the turn holder shank width builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

bool NXOpen::CAM::TurningToolBuilder::HolderUse ( )

Returns the use turn holder toggle
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::HolderWidthBuilder ( )

Returns the turn holder width builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::InsertLengthBuilder ( )

Returns the insert length builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::TurningToolBuilder::InsertPositions NXOpen::CAM::TurningToolBuilder::InsertPosition ( )

Returns the insert position
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::InsertWidthBuilder ( )

Returns the insert width builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::LeftAngleBuilder ( )

Returns the left angle builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::ManageToolPartBuilder* NXOpen::CAM::TurningToolBuilder::ManageToolPartBuilder ( )

Returns the manage tool part builder
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::MaxDepthBuilder ( )

Returns the max.

depth builder (inheritable double)
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

bool NXOpen::CAM::TurningToolBuilder::MaxDepthToggle ( )

Returns the max.

depth toggle
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::MaxFacingDiameterBuilder ( )

Returns the max.

facing diameter builder (inheritable double)
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

bool NXOpen::CAM::TurningToolBuilder::MaxFacingDiameterToggle ( )

Returns the max.

facing diameter toggle
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::MaxToolReachBuilder ( )

Returns the max.

tool reach builder (inheritable double)
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

bool NXOpen::CAM::TurningToolBuilder::MaxToolReachToggle ( )

Returns the max.

tool reach toggle
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::NCGroup* NXOpen::CAM::TurningToolBuilder::McsSpindleGroup ( )

Returns the MCS spindle group
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::MinBoringDiameterBuilder ( )

Returns the min.

boring diameter builder (inheritable double)
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

bool NXOpen::CAM::TurningToolBuilder::MinBoringDiameterToggle ( )

Returns the min.

boring diameter toggle
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::MinFacingDiameterBuilder ( )

Returns the min.

facing diameter builder (inheritable double)
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

bool NXOpen::CAM::TurningToolBuilder::MinFacingDiameterToggle ( )

Returns the min.

facing diameter toggle
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::NoseRadiusBuilder ( )

Returns the nose radius builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::NoseWidthBuilder ( )

Returns the nose width builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::OrientAngleBuilder ( )

Returns the orient angle builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::RightAngleBuilder ( )

Returns the right angle builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::TurningToolBuilder::SetHolderLock ( bool  holderLock)

Sets the lock turn holder toggle
Created in NX5.0.0.



License requirements : None

Parameters
holderLockthe lock turn holder toggle
void NXOpen::CAM::TurningToolBuilder::SetHolderShankType ( NXOpen::CAM::TurningToolBuilder::HolderShankTypes  holderShankType)

Sets the turn holder shank type
Created in NX5.0.0.



License requirements : None

Parameters
holderShankTypeholdershanktype
void NXOpen::CAM::TurningToolBuilder::SetHolderUse ( bool  holderUse)

Sets the use turn holder toggle
Created in NX5.0.0.



License requirements : None

Parameters
holderUsethe use turn holder toggle
void NXOpen::CAM::TurningToolBuilder::SetInsertPosition ( NXOpen::CAM::TurningToolBuilder::InsertPositions  insertPosition)

Sets the insert position
Created in NX5.0.0.



License requirements : None

Parameters
insertPositioninsertposition
void NXOpen::CAM::TurningToolBuilder::SetMaxDepthToggle ( bool  maxDepthToggle)

Sets the max.

depth toggle
Created in NX5.0.0.

License requirements : None

Parameters
maxDepthTogglemaxdepthtoggle
void NXOpen::CAM::TurningToolBuilder::SetMaxFacingDiameterToggle ( bool  maxFacingDiameterToggle)

Sets the max.

facing diameter toggle
Created in NX5.0.0.

License requirements : None

Parameters
maxFacingDiameterTogglemaxfacingdiametertoggle
void NXOpen::CAM::TurningToolBuilder::SetMaxToolReachToggle ( bool  maxToolReachToggle)

Sets the max.

tool reach toggle
Created in NX5.0.0.

License requirements : None

Parameters
maxToolReachTogglemaxtoolreachtoggle
void NXOpen::CAM::TurningToolBuilder::SetMcsSpindleGroup ( NXOpen::CAM::NCGroup mcsSpindleGroup)

Sets the MCS spindle group
Created in NX7.5.0.



License requirements : None

Parameters
mcsSpindleGroupthe tag of the MCS spindle group
void NXOpen::CAM::TurningToolBuilder::SetMinBoringDiameterToggle ( bool  minBoringDiameterToggle)

Sets the min.

boring diameter toggle
Created in NX5.0.0.

License requirements : None

Parameters
minBoringDiameterToggleminboringdiametertoggle
void NXOpen::CAM::TurningToolBuilder::SetMinFacingDiameterToggle ( bool  minFacingDiameterToggle)

Sets the min.

facing diameter toggle
Created in NX5.0.0.

License requirements : None

Parameters
minFacingDiameterToggleminfacingdiametertoggle
NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::ThicknessBuilder ( )

Returns the thickness builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::TrackingBuilder* NXOpen::CAM::TurningToolBuilder::TrackingBuilder ( )

Returns the tracking point builder
Created in NX5.0.1.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::XMountBuilder ( )

Returns the x mount builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::TurningToolBuilder::YMountBuilder ( )

Returns the y mount builder (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")


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