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

Represents a MillingTool Builder
This is an abstract class, and cannot be instantiated. More...

Inheritance diagram for NXOpen::CAM::MillingToolBuilder:
NXOpen::CAM::ToolBuilder NXOpen::CAM::NCGroupBuilder NXOpen::CAM::ParamBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::CAM::BarrelToolBuilder NXOpen::CAM::DrillToolBuilder NXOpen::CAM::MillFormToolBuilder NXOpen::CAM::MillToolBuilder NXOpen::CAM::TToolBuilder NXOpen::CAM::DrillBackCountersinkTool NXOpen::CAM::DrillBackSpotfacingToolBuilder NXOpen::CAM::DrillBoreToolBuilder NXOpen::CAM::DrillBoringBarTool NXOpen::CAM::DrillBurnishingToolBuilder NXOpen::CAM::DrillCenterBellToolBuilder NXOpen::CAM::DrillCoreToolBuilder NXOpen::CAM::DrillCounterboreToolBuilder NXOpen::CAM::DrillCtskToolBuilder NXOpen::CAM::DrillReamerToolBuilder NXOpen::CAM::DrillSpotdrillToolBuilder NXOpen::CAM::DrillSpotfaceToolBuilder NXOpen::CAM::DrillStdToolBuilder NXOpen::CAM::DrillStepToolBuilder NXOpen::CAM::DrillTapToolBuilder NXOpen::CAM::DrillThreadMillToolBuilder

Public Types

enum  ToolDirectionTypes { ToolDirectionTypesNone, ToolDirectionTypesClw, ToolDirectionTypesCclw }
 Available types for tool direction milling tool. More...
 

Public Member Functions

bool CoolantThrough ()
 Returns the coolant through parameter
Created in NX7.5.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderHelicalDiameter ()
 Returns the helical diameter
Created in NX8.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderHelicalRampAngle ()
 Returns the ramp angle
Created in NX8.0.0. More...
 
NXOpen::CAM::HolderSectionBuilderHolderSectionBuilder ()
 Returns the holder sections builder
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderMaxCutWidth ()
 Returns the max cut width
Created in NX8.0.0. More...
 
NXOpen::CAM::MillingTrackpointBuilderMillingTrackpointBuilder ()
 Returns the mill trackpoint builder
Created in NX6.0.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderMinRampLength ()
 Returns the min ramp length
Created in NX8.0.0. More...
 
void SetCoolantThrough (bool coolantThrough)
 Sets the coolant through parameter
Created in NX7.5.0. More...
 
void SetTlCutcomReg (int tlCutcomRegValue)
 Sets the Cutcom Register
Created in NX5.0.0. More...
 
void SetTlDirection (NXOpen::CAM::MillingToolBuilder::ToolDirectionTypes tlDirection)
 Sets the tool direction
Created in NX5.0.0. More...
 
void SetTlHolderDescription (const NXString &tlHolderDescriptionValue)
 Sets the Holder Description
Created in NX5.0.0. More...
 
void SetTlHolderDescription (const char *tlHolderDescriptionValue)
 Sets the Holder Description
Created in NX5.0.0. More...
 
void SetTlHolderLibref (const NXString &tlHolderLibrefValue)
 Sets the Holder Library Reference
Created in NX5.0.0. More...
 
void SetTlHolderLibref (const char *tlHolderLibrefValue)
 Sets the Holder Library Reference
Created in NX5.0.0. More...
 
void SetUseTaperedShank (bool useTaperedShank)
 Sets the use tapered shank
Created in NX8.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderTaperedShankDiameterBuilder ()
 Returns the tapered shank diameter
Created in NX8.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderTaperedShankLengthBuilder ()
 Returns the tapered shank length
Created in NX8.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderTaperedShankTaperLengthBuilder ()
 Returns the tapered shank taper length
Created in NX8.0.0. More...
 
NXOpen::CAM::InheritableIntBuilderTlAdjRegBuilder ()
 Returns the Adjust Register
Created in NX5.0.0. More...
 
int TlCutcomReg ()
 Returns the Cutcom Register
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableIntBuilderTlCutcomRegBuilder ()
 Returns the Cutcom Register Builder
Created in NX6.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderTlDiameterBuilder ()
 Returns the Tool Diameter builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::MillingToolBuilder::ToolDirectionTypes TlDirection ()
 Returns the tool direction
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderTlFluteLnBuilder ()
 Returns the flute length
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderTlHeightBuilder ()
 Returns the length
Created in NX5.0.0. More...
 
NXString TlHolderDescription ()
 Returns the Holder Description
Created in NX5.0.0. More...
 
NXString TlHolderLibref ()
 Returns the Holder Library Reference
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderTlLowCorRadBuilder ()
 Returns the low corner radius
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableIntBuilderTlNumFlutesBuilder ()
 Returns the Number of Flutes builder (inheritable integer)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderTlShankDiaBuilder ()
 Returns the Shank Diameter builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderTlTaperAngBuilder ()
 Returns the Taper Angle builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderTlUpCorRadBuilder ()
 Returns the up corner radius
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderTlZMountBuilder ()
 Returns the Z Mount builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderTlZOffsetBuilder ()
 Returns the Z Offset builder (inheritable double)
Created in NX5.0.0. More...
 
bool UseTaperedShank ()
 Returns the use tapered shank
Created in NX8.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 MillingTool Builder
This is an abstract class, and cannot be instantiated.



Created in NX5.0.0.

Member Enumeration Documentation

Available types for tool direction milling tool.

Enumerator
ToolDirectionTypesNone 

None.

ToolDirectionTypesClw 

CLW.

ToolDirectionTypesCclw 

CCLW.

Member Function Documentation

bool NXOpen::CAM::MillingToolBuilder::CoolantThrough ( )

Returns the coolant through parameter
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::MillingToolBuilder::HelicalDiameter ( )

Returns the helical diameter
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::MillingToolBuilder::HelicalRampAngle ( )

Returns the ramp angle
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::HolderSectionBuilder* NXOpen::CAM::MillingToolBuilder::HolderSectionBuilder ( )

Returns the holder sections builder
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::MillingToolBuilder::MaxCutWidth ( )

Returns the max cut width
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::MillingTrackpointBuilder* NXOpen::CAM::MillingToolBuilder::MillingTrackpointBuilder ( )

Returns the mill trackpoint builder
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::MillingToolBuilder::MinRampLength ( )

Returns the min ramp length
Created in NX8.0.0.



License requirements : None

void NXOpen::CAM::MillingToolBuilder::SetCoolantThrough ( bool  coolantThrough)

Sets the coolant through parameter
Created in NX7.5.0.



License requirements : None

Parameters
coolantThroughthe coolant through
void NXOpen::CAM::MillingToolBuilder::SetTlCutcomReg ( int  tlCutcomRegValue)

Sets the Cutcom Register
Created in NX5.0.0.



License requirements : None

Parameters
tlCutcomRegValuethe tool cutcom register value
void NXOpen::CAM::MillingToolBuilder::SetTlDirection ( NXOpen::CAM::MillingToolBuilder::ToolDirectionTypes  tlDirection)

Sets the tool direction
Created in NX5.0.0.



License requirements : None

Parameters
tlDirectiontldirection
void NXOpen::CAM::MillingToolBuilder::SetTlHolderDescription ( const NXString tlHolderDescriptionValue)

Sets the Holder Description
Created in NX5.0.0.



License requirements : None

Parameters
tlHolderDescriptionValuethe tool holder description value
void NXOpen::CAM::MillingToolBuilder::SetTlHolderDescription ( const char *  tlHolderDescriptionValue)

Sets the Holder Description
Created in NX5.0.0.



License requirements : None

Parameters
tlHolderDescriptionValuethe tool holder description value
void NXOpen::CAM::MillingToolBuilder::SetTlHolderLibref ( const NXString tlHolderLibrefValue)

Sets the Holder Library Reference
Created in NX5.0.0.



License requirements : None

Parameters
tlHolderLibrefValuethe holder Library Reference value
void NXOpen::CAM::MillingToolBuilder::SetTlHolderLibref ( const char *  tlHolderLibrefValue)

Sets the Holder Library Reference
Created in NX5.0.0.



License requirements : None

Parameters
tlHolderLibrefValuethe holder Library Reference value
void NXOpen::CAM::MillingToolBuilder::SetUseTaperedShank ( bool  useTaperedShank)

Sets the use tapered shank
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
useTaperedShankuse tapered shank
NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::MillingToolBuilder::TaperedShankDiameterBuilder ( )

Returns the tapered shank diameter
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::MillingToolBuilder::TaperedShankLengthBuilder ( )

Returns the tapered shank length
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::MillingToolBuilder::TaperedShankTaperLengthBuilder ( )

Returns the tapered shank taper length
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::InheritableIntBuilder* NXOpen::CAM::MillingToolBuilder::TlAdjRegBuilder ( )

Returns the Adjust Register
Created in NX5.0.0.



License requirements : None

int NXOpen::CAM::MillingToolBuilder::TlCutcomReg ( )

Returns the Cutcom Register
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::InheritableIntBuilder* NXOpen::CAM::MillingToolBuilder::TlCutcomRegBuilder ( )

Returns the Cutcom Register Builder
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::MillingToolBuilder::TlDiameterBuilder ( )

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



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::MillingToolBuilder::ToolDirectionTypes NXOpen::CAM::MillingToolBuilder::TlDirection ( )

Returns the tool direction
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::MillingToolBuilder::TlFluteLnBuilder ( )

Returns the flute length
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::MillingToolBuilder::TlHeightBuilder ( )

Returns the length
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXString NXOpen::CAM::MillingToolBuilder::TlHolderDescription ( )

Returns the Holder Description
Created in NX5.0.0.



License requirements : None

NXString NXOpen::CAM::MillingToolBuilder::TlHolderLibref ( )

Returns the Holder Library Reference
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::MillingToolBuilder::TlLowCorRadBuilder ( )

Returns the low corner radius
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableIntBuilder* NXOpen::CAM::MillingToolBuilder::TlNumFlutesBuilder ( )

Returns the Number of Flutes builder (inheritable integer)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::MillingToolBuilder::TlShankDiaBuilder ( )

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



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::MillingToolBuilder::TlTaperAngBuilder ( )

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



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::MillingToolBuilder::TlUpCorRadBuilder ( )

Returns the up corner radius
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::MillingToolBuilder::TlZMountBuilder ( )

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



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::MillingToolBuilder::TlZOffsetBuilder ( )

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



License requirements : cam_base ("CAM BASE")

bool NXOpen::CAM::MillingToolBuilder::UseTaperedShank ( )

Returns the use tapered shank
Created in NX8.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.