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

Inheritance diagram for NXOpen::CAM::ToolBuilder:

Public Member Functions
NXString	ChannelName ()
	Returns the channel's name Created in NX7.5.0.

NXString	GetMaterial ()
	Get tool material.

void	GetMaterialData (NXString libRef, NXString name, NXString description, NXString code)
	Get material data Created in NX8.0.2.

NXString	HolderDescription ()
	Returns the holder description Created in NX7.5.1.

NXString	HolderLibraryReference ()
	Returns the holder libref Created in NX7.5.1.

NXOpen::CAM::Ude *	LibraryParametersBuilder ()
	Returns the Library Data Object Created in NX9.0.0.

void	SetChannelName (const NXString &name)
	Sets the channel's name Created in NX7.5.0.

void	SetChannelName (const char *name)
	Sets the channel's name Created in NX7.5.0.

void	SetHolderDescription (const NXString &holderDescriptionValue)
	Sets the holder description Created in NX7.5.1.

void	SetHolderDescription (const char *holderDescriptionValue)
	Sets the holder description Created in NX7.5.1.

void	SetHolderLibraryReference (const NXString &holderLibrefValue)
	Sets the holder libref Created in NX7.5.1.

void	SetHolderLibraryReference (const char *holderLibrefValue)
	Sets the holder libref Created in NX7.5.1.

void	SetMaterial (const NXString &libRef)
	Set tool material Created in NX8.0.1.

void	SetMaterial (const char *libRef)
	Set tool material Created in NX8.0.1.

void	SetTlCtlgNum (const NXString &tlCtlgNumValue)
	Sets the Catalog Number Created in NX5.0.0.

void	SetTlCtlgNum (const char *tlCtlgNumValue)
	Sets the Catalog Number Created in NX5.0.0.

void	SetTlDescription (const NXString &tlDescriptionValue)
	Sets the Cutter Description Created in NX5.0.0.

void	SetTlDescription (const char *tlDescriptionValue)
	Sets the Cutter Description Created in NX5.0.0.

void	SetTlLibref (const NXString &tlLibRef)
	Sets the Cutter Libref Created in NX5.0.0.

void	SetTlLibref (const char *tlLibRef)
	Sets the Cutter Libref Created in NX5.0.0.

void	SetTlManualToolChange (bool tlManualToolChangeValue)
	Sets the Manual Tool Change Created in NX5.0.0.

void	SetTlText (const NXString &tlText)
	Sets the tool text Created in NX5.0.0.

void	SetTlText (const char *tlText)
	Sets the tool text Created in NX5.0.0.

NXString	TlCtlgNum ()
	Returns the Catalog Number Created in NX5.0.0.

NXString	TlDescription ()
	Returns the Cutter Description Created in NX5.0.0.

NXOpen::CAM::InheritableIntBuilder *	TlHolderNumberBuilder ()
	Returns the Holder Number Created in NX5.0.0.

NXString	TlLibref ()
	Returns the Cutter Libref Created in NX5.0.0.

bool	TlManualToolChange ()
	Returns the Manual Tool Change Created in NX5.0.0.

NXOpen::CAM::InheritableIntBuilder *	TlNumberBuilder ()
	Returns the Tool Number Created in NX5.0.0.

NXString	TlText ()
	Returns the tool text Created in NX5.0.0.

Public Member Functions inherited from NXOpen::CAM::NCGroupBuilder
NXString	Description ()
	Returns the description Created in NX9.0.0.

NXOpen::CAM::UdeSet *	EndUdeSet ()
	Returns the end ude set Created in NX7.5.0.

void	SetDescription (const NXString &description)
	Sets the description Created in NX9.0.0.

void	SetDescription (const char *description)
	Sets the description Created in NX9.0.0.

NXOpen::CAM::UdeSet *	StartUdeSet ()
	Returns the start ude set Created in NX7.5.0.

Public Member Functions inherited from NXOpen::CAM::ParamBuilder
NXOpen::CAM::Ude *	CycleEvent ()
	Returns the cycle event Created in NX7.5.0.

NXOpen::CAM::Cycle *	CycleTable ()
	Returns the cycle Created in NX9.0.0.

NXOpen::CAM::ParamBuilder::OptimizationTypes	OptimizationMethod ()
	Returns the optim method Created in NX5.0.0.

void	SetOptimizationMethod (NXOpen::CAM::ParamBuilder::OptimizationTypes optimMethod)
	Sets the optim method Created in NX5.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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

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

libRef	libref
name	name
description	description
code	code

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.