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

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

Inheritance diagram for NXOpen::CAM::ToolBuilder:
NXOpen::CAM::NCGroupBuilder NXOpen::CAM::ParamBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::CAM::MillingToolBuilder NXOpen::CAM::SoftTool NXOpen::CAM::SolidToolBuilder NXOpen::CAM::TurningToolBuilder NXOpen::CAM::WireTool NXOpen::CAM::BarrelToolBuilder NXOpen::CAM::DrillToolBuilder NXOpen::CAM::MillFormToolBuilder NXOpen::CAM::MillToolBuilder NXOpen::CAM::TToolBuilder NXOpen::CAM::LaserTool NXOpen::CAM::GenericToolBuilder NXOpen::CAM::InspectionProbeToolBuilder NXOpen::CAM::ProbeToolBuilder NXOpen::CAM::FormToolBuilder NXOpen::CAM::GrooveToolBuilder NXOpen::CAM::ThreadToolBuilder NXOpen::CAM::TurnToolBuilder

Public Member Functions

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

Additional Inherited Members

- Public Types inherited from NXOpen::CAM::ParamBuilder
enum  OptimizationTypes { OptimizationTypesNone, OptimizationTypesMinimizeTravel, OptimizationTypesBand }
 Available types for Optimization Method in operation. More...
 

Detailed Description

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



Created in NX5.0.0.

Member Function Documentation

NXString NXOpen::CAM::ToolBuilder::ChannelName ( )

Returns the channel's name
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::CutterExport* NXOpen::CAM::ToolBuilder::CutterExportBuilder ( )

Returns the cutter export builder
Created in NX9.0.1.



License requirements : None

NXString NXOpen::CAM::ToolBuilder::GetMaterial ( )

Get tool material.

Returns

Created in NX8.0.1.

License requirements : None
void NXOpen::CAM::ToolBuilder::GetMaterialData ( NXString libRef,
NXString name,
NXString description,
NXString code 
)

Get material data
Created in NX8.0.2.



License requirements : None

Parameters
libReflibref
namename
descriptiondescription
codecode
NXString NXOpen::CAM::ToolBuilder::HolderDescription ( )

Returns the holder description
Created in NX7.5.1.



License requirements : None

NXString NXOpen::CAM::ToolBuilder::HolderLibraryReference ( )

Returns the holder libref
Created in NX7.5.1.



License requirements : None

NXOpen::CAM::Ude* NXOpen::CAM::ToolBuilder::LibraryParametersBuilder ( )

Returns the Library Data Object
Created in NX9.0.0.



License requirements : None

void NXOpen::CAM::ToolBuilder::SetChannelName ( const NXString name)

Sets the channel's name
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
namethe channel's name
void NXOpen::CAM::ToolBuilder::SetChannelName ( const char *  name)

Sets the channel's name
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
namethe channel's name
void NXOpen::CAM::ToolBuilder::SetHolderDescription ( const NXString holderDescriptionValue)

Sets the holder description
Created in NX7.5.1.



License requirements : cam_base ("CAM BASE")

Parameters
holderDescriptionValuethe tool holder description value
void NXOpen::CAM::ToolBuilder::SetHolderDescription ( const char *  holderDescriptionValue)

Sets the holder description
Created in NX7.5.1.



License requirements : cam_base ("CAM BASE")

Parameters
holderDescriptionValuethe tool holder description value
void NXOpen::CAM::ToolBuilder::SetHolderLibraryReference ( const NXString holderLibrefValue)

Sets the holder libref
Created in NX7.5.1.



License requirements : cam_base ("CAM BASE")

Parameters
holderLibrefValuethe tool holder library reference value
void NXOpen::CAM::ToolBuilder::SetHolderLibraryReference ( const char *  holderLibrefValue)

Sets the holder libref
Created in NX7.5.1.



License requirements : cam_base ("CAM BASE")

Parameters
holderLibrefValuethe tool holder library reference value
void NXOpen::CAM::ToolBuilder::SetMaterial ( const NXString libRef)

Set tool material
Created in NX8.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
libReflibref
void NXOpen::CAM::ToolBuilder::SetMaterial ( const char *  libRef)

Set tool material
Created in NX8.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
libReflibref
void NXOpen::CAM::ToolBuilder::SetTlCtlgNum ( const NXString tlCtlgNumValue)

Sets the Catalog Number
Created in NX5.0.0.



License requirements : None

Parameters
tlCtlgNumValuethe catalog number value
void NXOpen::CAM::ToolBuilder::SetTlCtlgNum ( const char *  tlCtlgNumValue)

Sets the Catalog Number
Created in NX5.0.0.



License requirements : None

Parameters
tlCtlgNumValuethe catalog number value
void NXOpen::CAM::ToolBuilder::SetTlDescription ( const NXString tlDescriptionValue)

Sets the Cutter Description
Created in NX5.0.0.



License requirements : None

Parameters
tlDescriptionValuethe cutter description value
void NXOpen::CAM::ToolBuilder::SetTlDescription ( const char *  tlDescriptionValue)

Sets the Cutter Description
Created in NX5.0.0.



License requirements : None

Parameters
tlDescriptionValuethe cutter description value
void NXOpen::CAM::ToolBuilder::SetTlLibref ( const NXString tlLibRef)

Sets the Cutter Libref
Created in NX5.0.0.



License requirements : None

Parameters
tlLibRefthe cutter libref value
void NXOpen::CAM::ToolBuilder::SetTlLibref ( const char *  tlLibRef)

Sets the Cutter Libref
Created in NX5.0.0.



License requirements : None

Parameters
tlLibRefthe cutter libref value
void NXOpen::CAM::ToolBuilder::SetTlManualToolChange ( bool  tlManualToolChangeValue)

Sets the Manual Tool Change
Created in NX5.0.0.



License requirements : None

Parameters
tlManualToolChangeValuethe manual tool change value
void NXOpen::CAM::ToolBuilder::SetTlText ( const NXString tlText)

Sets the tool text
Created in NX5.0.0.



License requirements : None

Parameters
tlTextthe tool text value
void NXOpen::CAM::ToolBuilder::SetTlText ( const char *  tlText)

Sets the tool text
Created in NX5.0.0.



License requirements : None

Parameters
tlTextthe tool text value
NXString NXOpen::CAM::ToolBuilder::TlCtlgNum ( )

Returns the Catalog Number
Created in NX5.0.0.



License requirements : None

NXString NXOpen::CAM::ToolBuilder::TlDescription ( )

Returns the Cutter Description
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::InheritableIntBuilder* NXOpen::CAM::ToolBuilder::TlHolderNumberBuilder ( )

Returns the Holder Number
Created in NX5.0.0.



License requirements : None

NXString NXOpen::CAM::ToolBuilder::TlLibref ( )

Returns the Cutter Libref
Created in NX5.0.0.



License requirements : None

bool NXOpen::CAM::ToolBuilder::TlManualToolChange ( )

Returns the Manual Tool Change
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::InheritableIntBuilder* NXOpen::CAM::ToolBuilder::TlNumberBuilder ( )

Returns the Tool Number
Created in NX5.0.0.



License requirements : None

NXString NXOpen::CAM::ToolBuilder::TlText ( )

Returns the tool text
Created in NX5.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.