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:

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.
NXOpen::CAM::InheritableToolDepBuilder *	HelicalDiameter ()
	Returns the helical diameter Created in NX8.0.0.
NXOpen::CAM::InheritableDoubleBuilder *	HelicalRampAngle ()
	Returns the ramp angle Created in NX8.0.0.
NXOpen::CAM::HolderSectionBuilder *	HolderSectionBuilder ()
	Returns the holder sections builder Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilder *	MaxCutWidth ()
	Returns the max cut width Created in NX8.0.0.
NXOpen::CAM::MillingTrackpointBuilder *	MillingTrackpointBuilder ()
	Returns the mill trackpoint builder Created in NX6.0.0.
NXOpen::CAM::InheritableToolDepBuilder *	MinRampLength ()
	Returns the min ramp length Created in NX8.0.0.
void	SetCoolantThrough (bool coolantThrough)
	Sets the coolant through parameter Created in NX7.5.0.
void	SetTlCutcomReg (int tlCutcomRegValue)
	Sets the Cutcom Register Created in NX5.0.0.
void	SetTlDirection (NXOpen::CAM::MillingToolBuilder::ToolDirectionTypes tlDirection)
	Sets the tool direction Created in NX5.0.0.
void	SetTlHolderDescription (const NXString &tlHolderDescriptionValue)
	Sets the Holder Description Created in NX5.0.0.
void	SetTlHolderDescription (const char *tlHolderDescriptionValue)
	Sets the Holder Description Created in NX5.0.0.
void	SetTlHolderLibref (const NXString &tlHolderLibrefValue)
	Sets the Holder Library Reference Created in NX5.0.0.
void	SetTlHolderLibref (const char *tlHolderLibrefValue)
	Sets the Holder Library Reference Created in NX5.0.0.
void	SetUseTaperedShank (bool useTaperedShank)
	Sets the use tapered shank Created in NX8.0.0.
NXOpen::CAM::InheritableDoubleBuilder *	TaperedShankDiameterBuilder ()
	Returns the tapered shank diameter Created in NX8.0.0.
NXOpen::CAM::InheritableDoubleBuilder *	TaperedShankLengthBuilder ()
	Returns the tapered shank length Created in NX8.0.0.
NXOpen::CAM::InheritableDoubleBuilder *	TaperedShankTaperLengthBuilder ()
	Returns the tapered shank taper length Created in NX8.0.0.
NXOpen::CAM::InheritableIntBuilder *	TlAdjRegBuilder ()
	Returns the Adjust Register Created in NX5.0.0.
int	TlCutcomReg ()
	Returns the Cutcom Register Created in NX5.0.0.
NXOpen::CAM::InheritableIntBuilder *	TlCutcomRegBuilder ()
	Returns the Cutcom Register Builder Created in NX6.0.0.
NXOpen::CAM::InheritableDoubleBuilder *	TlDiameterBuilder ()
	Returns the Tool Diameter builder (inheritable double) Created in NX5.0.0.
NXOpen::CAM::MillingToolBuilder::ToolDirectionTypes	TlDirection ()
	Returns the tool direction Created in NX5.0.0.
NXOpen::CAM::InheritableDoubleBuilder *	TlFluteLnBuilder ()
	Returns the flute length Created in NX5.0.0.
NXOpen::CAM::InheritableDoubleBuilder *	TlHeightBuilder ()
	Returns the length Created in NX5.0.0.
NXString	TlHolderDescription ()
	Returns the Holder Description Created in NX5.0.0.
NXString	TlHolderLibref ()
	Returns the Holder Library Reference Created in NX5.0.0.
NXOpen::CAM::InheritableDoubleBuilder *	TlLowCorRadBuilder ()
	Returns the low corner radius Created in NX5.0.0.
NXOpen::CAM::InheritableIntBuilder *	TlNumFlutesBuilder ()
	Returns the Number of Flutes builder (inheritable integer) Created in NX5.0.0.
NXOpen::CAM::InheritableDoubleBuilder *	TlShankDiaBuilder ()
	Returns the Shank Diameter builder (inheritable double) Created in NX5.0.0.
NXOpen::CAM::InheritableDoubleBuilder *	TlTaperAngBuilder ()
	Returns the Taper Angle builder (inheritable double) Created in NX5.0.0.
NXOpen::CAM::InheritableDoubleBuilder *	TlUpCorRadBuilder ()
	Returns the up corner radius Created in NX5.0.0.
NXOpen::CAM::InheritableDoubleBuilder *	TlZMountBuilder ()
	Returns the Z Mount builder (inheritable double) Created in NX5.0.0.
NXOpen::CAM::InheritableDoubleBuilder *	TlZOffsetBuilder ()
	Returns the Z Offset builder (inheritable double) Created in NX5.0.0.
bool	UseTaperedShank ()
	Returns the use tapered shank Created in NX8.0.0.
Public Member Functions inherited from NXOpen::CAM::ToolBuilder
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.

Detailed Description

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

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::MillingToolBuilder::ToolDirectionTypes

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

coolantThrough

the coolant through

void NXOpen::CAM::MillingToolBuilder::SetTlCutcomReg

(

int

tlCutcomRegValue

)

Sets the Cutcom Register
Created in NX5.0.0.

License requirements : None

Parameters

tlCutcomRegValue

the 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

tlDirection

tldirection

void NXOpen::CAM::MillingToolBuilder::SetTlHolderDescription

(

const NXString &

tlHolderDescriptionValue

)

Sets the Holder Description
Created in NX5.0.0.

License requirements : None

Parameters

tlHolderDescriptionValue

the 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

tlHolderDescriptionValue

the 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

tlHolderLibrefValue

the 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

tlHolderLibrefValue

the 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

useTaperedShank

use 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:

• CAM_MillingToolBuilder.hxx