Represents a Groove tool builder
To create a new instance of this class, use NXOpen::CAM::NCGroupCollection::CreateGrooveToolBuilder

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAM::GrooveToolBuilder:

Public Types
enum	HolderGrooveHands { HolderGrooveHandsLeft, HolderGrooveHandsRight }
	The available holder groove hand options for groove tools. More...

enum	HolderHands { HolderHandsLeft0, HolderHandsLeft90, HolderHandsRight0, HolderHandsRight90 }
	The available holder hand options for groove tools. More...

enum	HolderStyles { HolderStylesDeg0, HolderStylesDeg45, HolderStylesDeg90, HolderStylesUserDefined }
	The available holder style options for groove tools. More...

enum	InsertShapes { InsertShapesStd, InsertShapesFnr, InsertShapesRtj, InsertShapesUser }
	The available insert shapes for groove tools. More...

Public Types inherited from NXOpen::CAM::TurningToolBuilder
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::GrooveToolBuilder::HolderGrooveHands	HolderGrooveHand ()
	Returns the holder groove hand Created in NX6.0.0. More...

NXOpen::CAM::GrooveToolBuilder::HolderHands	HolderHand ()
	Returns the holder hand Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	HolderInsertExtensionBuilder ()
	Returns the holder insert extension builder (inheritable double) for groove tools Created in NX5.0.0. More...

NXOpen::CAM::GrooveToolBuilder::HolderStyles	HolderStyle ()
	Returns the holder style Created in NX5.0.0. More...

NXOpen::CAM::GrooveToolBuilder::InsertShapes	InsertShape ()
	Returns the insert shape Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	LeftRadiusBuilder ()
	Returns the left radius builder (inheritable double) Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	RadiusBuilder ()
	Returns the radius builder (inheritable double) Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	RightRadiusBuilder ()
	Returns the right radius builder (inheritable double) Created in NX5.0.0. More...

void	SetHolderGrooveHand (NXOpen::CAM::GrooveToolBuilder::HolderGrooveHands holderHand)
	Sets the holder groove hand Created in NX6.0.0. More...

void	SetHolderHand (NXOpen::CAM::GrooveToolBuilder::HolderHands holderHand)
	Sets the holder hand Created in NX5.0.0. More...

void	SetHolderStyle (NXOpen::CAM::GrooveToolBuilder::HolderStyles holderStyle)
	Sets the holder style Created in NX5.0.0. More...

void	SetInsertShape (NXOpen::CAM::GrooveToolBuilder::InsertShapes insertShape)
	Sets the insert shape Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	SideAngleBuilder ()
	Returns the side angle builder (inheritable double) Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	TipAngleBuilder ()
	Returns the tip angle builder (inheritable double) Created in NX5.0.0. More...

Public Member Functions inherited from NXOpen::CAM::TurningToolBuilder
NXOpen::CAM::InheritableDoubleBuilder *	HolderAngleBuilder ()
	Returns the holder angle builder (inheritable double) Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	HolderLengthBuilder ()
	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::InheritableDoubleBuilder *	HolderShankLineBuilder ()
	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::InheritableDoubleBuilder *	HolderShankWidthBuilder ()
	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::InheritableDoubleBuilder *	HolderWidthBuilder ()
	Returns the turn holder width builder (inheritable double) Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	InsertLengthBuilder ()
	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::InheritableDoubleBuilder *	InsertWidthBuilder ()
	Returns the insert width builder (inheritable double) Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	LeftAngleBuilder ()
	Returns the left angle builder (inheritable double) Created in NX5.0.0. More...

NXOpen::CAM::ManageToolPartBuilder *	ManageToolPartBuilder ()
	Returns the manage tool part builder Created in NX6.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	MaxDepthBuilder ()
	Returns the max. More...

bool	MaxDepthToggle ()
	Returns the max. More...

NXOpen::CAM::InheritableDoubleBuilder *	MaxFacingDiameterBuilder ()
	Returns the max. More...

bool	MaxFacingDiameterToggle ()
	Returns the max. More...

NXOpen::CAM::InheritableDoubleBuilder *	MaxToolReachBuilder ()
	Returns the max. More...

bool	MaxToolReachToggle ()
	Returns the max. More...

NXOpen::CAM::NCGroup *	McsSpindleGroup ()
	Returns the MCS spindle group Created in NX7.5.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	MinBoringDiameterBuilder ()
	Returns the min. More...

bool	MinBoringDiameterToggle ()
	Returns the min. More...

NXOpen::CAM::InheritableDoubleBuilder *	MinFacingDiameterBuilder ()
	Returns the min. More...

bool	MinFacingDiameterToggle ()
	Returns the min. More...

NXOpen::CAM::InheritableDoubleBuilder *	NoseRadiusBuilder ()
	Returns the nose radius builder (inheritable double) Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	NoseWidthBuilder ()
	Returns the nose width builder (inheritable double) Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	OrientAngleBuilder ()
	Returns the orient angle builder (inheritable double) Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	RightAngleBuilder ()
	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::InheritableDoubleBuilder *	ThicknessBuilder ()
	Returns the thickness builder (inheritable double) Created in NX5.0.0. More...

NXOpen::CAM::TrackingBuilder *	TrackingBuilder ()
	Returns the tracking point builder Created in NX5.0.1. More...

NXOpen::CAM::InheritableDoubleBuilder *	XMountBuilder ()
	Returns the x mount builder (inheritable double) Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	YMountBuilder ()
	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::CutterExport *	CutterExportBuilder ()
	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::Ude *	LibraryParametersBuilder ()
	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::InheritableIntBuilder *	TlHolderNumberBuilder ()
	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::InheritableIntBuilder *	TlNumberBuilder ()
	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::UdeSet *	EndUdeSet ()
	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::UdeSet *	StartUdeSet ()
	Returns the start ude set Created in NX7.5.0. More...

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

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

NXOpen::TaggedObject *	GetCustomizableItemBuilder (const NXString &name)
	Returns the customizable item builder for the given customizable item name. More...

NXOpen::TaggedObject *	GetCustomizableItemBuilder (const char *name)
	Returns the customizable item builder for the given customizable item name. More...

std::vector< NXString >	GetCustomizableItemNames ()
	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::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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 Groove tool builder
To create a new instance of this class, use NXOpen::CAM::NCGroupCollection::CreateGrooveToolBuilder

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::GrooveToolBuilder::HolderGrooveHands

The available holder groove hand options for groove tools.

Enumerator
HolderGrooveHandsLeft	Left hand.
HolderGrooveHandsRight	Right hand.

enum NXOpen::CAM::GrooveToolBuilder::HolderHands

The available holder hand options for groove tools.

Enumerator
HolderHandsLeft0	Left hand, 0 degrees.
HolderHandsLeft90	Left hand, 90 degrees.
HolderHandsRight0	Right hand, 0 degrees.
HolderHandsRight90	Right hand, 90 degrees.

enum NXOpen::CAM::GrooveToolBuilder::HolderStyles

The available holder style options for groove tools.

Enumerator
HolderStylesDeg0	0 degrees
HolderStylesDeg45	45 degrees
HolderStylesDeg90	90 degrees
HolderStylesUserDefined	user defined

enum NXOpen::CAM::GrooveToolBuilder::InsertShapes

The available insert shapes for groove tools.

Enumerator
InsertShapesStd	Standard groove tool.
InsertShapesFnr	Full nose radius groove tool.
InsertShapesRtj	Ring type joint groove tool.
InsertShapesUser	user defined groove tool

Member Function Documentation

NXOpen::CAM::GrooveToolBuilder::HolderGrooveHands NXOpen::CAM::GrooveToolBuilder::HolderGrooveHand ( )

Returns the holder groove hand
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::GrooveToolBuilder::HolderHands NXOpen::CAM::GrooveToolBuilder::HolderHand ( )

Returns the holder hand
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::GrooveToolBuilder::HolderInsertExtensionBuilder ( )

Returns the holder insert extension builder (inheritable double) for groove tools
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::GrooveToolBuilder::HolderStyles NXOpen::CAM::GrooveToolBuilder::HolderStyle ( )

Returns the holder style
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::GrooveToolBuilder::InsertShapes NXOpen::CAM::GrooveToolBuilder::InsertShape ( )

Returns the insert shape
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::GrooveToolBuilder::LeftRadiusBuilder ( )

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

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::GrooveToolBuilder::RadiusBuilder ( )

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

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::GrooveToolBuilder::RightRadiusBuilder ( )

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

License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::GrooveToolBuilder::SetHolderGrooveHand ( NXOpen::CAM::GrooveToolBuilder::HolderGrooveHands holderHand )

Sets the holder groove hand
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

holderHand holderhand

void NXOpen::CAM::GrooveToolBuilder::SetHolderHand ( NXOpen::CAM::GrooveToolBuilder::HolderHands holderHand )

Sets the holder hand
Created in NX5.0.0.

License requirements : None

Parameters

holderHand holderhand

void NXOpen::CAM::GrooveToolBuilder::SetHolderStyle ( NXOpen::CAM::GrooveToolBuilder::HolderStyles holderStyle )

Sets the holder style
Created in NX5.0.0.

License requirements : None

Parameters

holderStyle holderstyle

void NXOpen::CAM::GrooveToolBuilder::SetInsertShape ( NXOpen::CAM::GrooveToolBuilder::InsertShapes insertShape )

Sets the insert shape
Created in NX5.0.0.

License requirements : None

Parameters

insertShape insertshape

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::GrooveToolBuilder::SideAngleBuilder ( )

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

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::GrooveToolBuilder::TipAngleBuilder ( )

Returns the tip angle 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:

CAM_GrooveToolBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation