Represents a HoleMaking Builder
To create a new instance of this class, use CAM::OperationCollection::CreateHoleMakingBuilder

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAM::HoleMakingBuilder:

Public Types
enum	ControlPointTypes { ControlPointTypesToolTip, ControlPointTypesShoulder }
	Available types for Control Point Type in Hole Making Operation. More...

enum	ModelDepthTypes { ModelDepthTypesAlways, ModelDepthTypesRule }
	Available types for model depth in Hole Making Operation. More...

enum	ToolAxisTypes { ToolAxisTypesPositiveZOfMcs, ToolAxisTypesFixedAxis, ToolAxisTypesAllAxes }
	the tool axis mode options More...

Public Types inherited from NXOpen::CAM::OperationBuilder
enum	HoleAxisTypes { HoleAxisTypesVector, HoleAxisTypesRule, HoleAxisTypesRuleIfNoVector }
	Available types for Hole Axis Type in feature milling and hole making. More...

enum	HoleDepthTypes { HoleDepthTypesPoint, HoleDepthTypesRule }
	Available types for Hole Depth Type in feature milling and hole making. More...

enum	OptimizationBasedOnTypes { OptimizationBasedOnTypesDist, OptimizationBasedOnTypesOrient }
	Available types for optimization based on in operation. More...

enum	OptimizationDistanceTypes { OptimizationDistanceTypesDirect, OptimizationDistanceTypesTransition }
	Available types for optimization distance method in operation. More...

enum	OptimizationLevelTypes { OptimizationLevelTypesStandard, OptimizationLevelTypesAdvanced }
	Available types for optimization level in operation. More...

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

Public Member Functions
bool	AllowOversizeTool ()
	Returns the Allow Oversize Tool flag Created in NX5.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	BlindHoleStockBuilder ()
	Returns the blind hole stock builder (inheritable double) Created in NX5.0.0.

bool	CheckFluteLength ()
	Returns the check flute length flag Created in NX5.0.0.

bool	CheckToolLength ()
	Returns the check tool length flag Created in NX5.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	ClrDistBuilder ()
	Returns the Clearance Distance builder (inheritable double) Created in NX5.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	ClrVertBuilder ()
	Returns the clearance vertical builder (inheritable double) Created in NX5.0.0.

NXOpen::CAM::HoleMakingBuilder::ControlPointTypes	ControlPointType ()
	Returns the control point type Created in NX5.0.0.

NXOpen::CAM::CutParameters *	CutParameters ()
	Returns the cut parameter object Created in NX6.0.0.

double	EngageFeedRate ()
	Returns the Engage Feed Rate Created in NX5.0.0.

NXOpen::CAM::FeedsBuilder *	FeedsBuilder ()
	Returns the feeds and speeds builder Created in NX5.0.0.

NXOpen::CAM::HoleMakingBuilder::ModelDepthTypes	ModelDepthType ()
	Returns the model depth type Created in NX5.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	OversizeToolPercentBuilder ()
	Returns the oversize tool percent builder (inheritable double) Created in NX5.0.0.

double	RapidFeedRate ()
	Returns the Rapid Feed Rate Created in NX5.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	RaptoOffsetBuilder ()
	Returns the rapto offset builder (inheritable double) Created in NX5.0.0.

bool	RaptoOffsetToggle ()
	Returns the rapto offset flag Created in NX5.0.0.

void	SetAllowOversizeTool (bool allowOversize)
	Sets the Allow Oversize Tool flag Created in NX5.0.0.

void	SetCheckFluteLength (bool checkFluteLength)
	Sets the check flute length flag Created in NX5.0.0.

void	SetCheckToolLength (bool checkToolLength)
	Sets the check tool length flag Created in NX5.0.0.

void	SetControlPointType (NXOpen::CAM::HoleMakingBuilder::ControlPointTypes controlPoint)
	Sets the control point type Created in NX5.0.0.

void	SetEngageFeedRate (double engageFeed)
	Sets the Engage Feed Rate Created in NX5.0.0.

void	SetModelDepthType (NXOpen::CAM::HoleMakingBuilder::ModelDepthTypes modelDepth)
	Sets the model depth type Created in NX5.0.0.

void	SetRapidFeedRate (double rapidFeed)
	Sets the Rapid Feed Rate Created in NX5.0.0.

void	SetRaptoOffsetToggle (bool raptoOffset)
	Sets the rapto offset flag Created in NX5.0.0.

void	SetToolAxisType (NXOpen::CAM::HoleMakingBuilder::ToolAxisTypes toolAxisType)
	Sets the tool axis mode Created in NX6.0.0.

void	SetToolAxisVector (NXOpen::NXObject *toolAxisVector)
	Sets the tool axis vector Created in NX6.0.0.

void	SetUseQuery (bool useQuery)
	Sets the use query flag Created in NX5.0.0.

void	SetUseUserDefinedTp (bool useUserTp)
	Sets the user defined tool path flag Created in NX5.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	ThruClearBuilder ()
	Returns the thru clear builder (inheritable double) Created in NX5.0.0.

NXOpen::CAM::HoleMakingBuilder::ToolAxisTypes	ToolAxisType ()
	Returns the tool axis mode Created in NX6.0.0.

NXOpen::NXObject *	ToolAxisVector ()
	Returns the tool axis vector Created in NX6.0.0.

bool	UseQuery ()
	Returns the use query flag Created in NX5.0.0.

bool	UseUserDefinedTp ()
	Returns the user defined tool path flag Created in NX5.0.0.

Public Member Functions inherited from NXOpen::CAM::OperationBuilder
NXString	ChannelName ()
	Returns the channel's name Created in NX7.5.0.

NXString	Description ()
	Returns the description Created in NX9.0.0.

NXOpen::CAM::PostEventsCiBuilder *	EndOfPath ()
	Returns the end event builder Created in NX5.0.1.

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

NXOpen::CAM::GeometryCiBuilder *	Geometry ()
	Returns the geometry builder Created in NX5.0.0.

std::vector< double >	GetHoleAxisValues ()
	Get the Hole Axis values.

bool	GougeChecking ()
	Returns the gouge checking flag Created in NX9.0.0.

NXOpen::CAM::OperationBuilder::HoleAxisTypes	HoleAxisType ()
	Returns the Hole Axis Type Created in NX5.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	HoleDepth ()
	Returns the max depth distance builder Created in NX5.0.0.

NXOpen::CAM::OperationBuilder::HoleDepthTypes	HoleDepthType ()
	Returns the Hole Depth Type Created in NX5.0.0.

NXOpen::CAM::ArcOutputTypeCiBuilder *	MotionOutputBuilder ()
	Returns the motion output builder Created in NX8.0.0.

NXOpen::CAM::Notes *	Notes ()
	Returns the notes builder Created in NX9.0.0.

NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes	OptimizationBasedOn ()
	Returns the optimization based on in operation Created in NX5.0.0.

NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes	OptimizationDistanceMethod ()
	Returns the optimization distance method in operation Created in NX5.0.0.

NXOpen::CAM::OperationBuilder::OptimizationLevelTypes	OptimizationLevel ()
	Returns the optimization level in operation Created in NX5.0.0.

NXOpen::CAM::OperationDisplayOptionsBuilder *	PathDisplayOptions ()
	Returns the path display options builder Created in NX6.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	RetractDistance ()
	Returns the Retract Distance builder (inheritable double) Created in NX5.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	RetractDistanceOnToolAxisChange ()
	Returns the Retract Distance on Tool Axis Change builder (inheritable double) Created in NX5.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	SafeClearance ()
	Returns the safe clearance builder Created in NX6.0.0.

bool	SelectToolFlag ()
	Returns the user selected tool Created in NX5.0.0.

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

void	SetChannelName (const char *channel)
	Sets the channel's name 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.

void	SetGougeChecking (bool gougeChecking)
	Sets the gouge checking flag Created in NX9.0.0.

void	SetHoleAxisType (NXOpen::CAM::OperationBuilder::HoleAxisTypes types)
	Sets the Hole Axis Type Created in NX5.0.0.

void	SetHoleAxisValues (const std::vector< double > &holeAxis)
	Set the Hole Axis values Created in NX5.0.0.

void	SetHoleDepthType (NXOpen::CAM::OperationBuilder::HoleDepthTypes types)
	Sets the Hole Depth Type Created in NX5.0.0.

void	SetOptimizationBasedOn (NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes optimBasedOn)
	Sets the optimization based on in operation Created in NX5.0.0.

void	SetOptimizationDistanceMethod (NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes optimDistance)
	Sets the optimization distance method in operation Created in NX5.0.0.

void	SetOptimizationLevel (NXOpen::CAM::OperationBuilder::OptimizationLevelTypes optimType)
	Sets the optimization level in operation Created in NX5.0.0.

void	SetSelectToolFlag (bool selToolFlag)
	Sets the user selected tool Created in NX5.0.0.

NXOpen::CAM::PostEventsCiBuilder *	StartOfPath ()
	Returns the start event builder Created in NX5.0.1.

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

NXOpen::CAM::ToolChangeCiBuilder *	ToolChangeSetting ()
	Returns the tool change builder Created in NX5.0.0.

NXOpen::CAM::ToolPathSplitParametersBuilder *	ToolPathSplitParametersBuilder ()
	Returns the tool path split Parameters Created in NX9.0.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 HoleMaking Builder
To create a new instance of this class, use CAM::OperationCollection::CreateHoleMakingBuilder

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::HoleMakingBuilder::ControlPointTypes

Available types for Control Point Type in Hole Making Operation.

Enumerator:

ControlPointTypesToolTip	tool tip
ControlPointTypesShoulder	shoulder

enum NXOpen::CAM::HoleMakingBuilder::ModelDepthTypes

Available types for model depth in Hole Making Operation.

Enumerator:

ModelDepthTypesAlways	always
ModelDepthTypesRule	rule

enum NXOpen::CAM::HoleMakingBuilder::ToolAxisTypes

the tool axis mode options

Enumerator:

ToolAxisTypesPositiveZOfMcs	Tool axis mode: +Z of MCS.
ToolAxisTypesFixedAxis	Tool axis mode: Fixed axis.
ToolAxisTypesAllAxes	Tool axis mode: All axes.

Member Function Documentation

bool NXOpen::CAM::HoleMakingBuilder::AllowOversizeTool ( )

Returns the Allow Oversize Tool flag
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::HoleMakingBuilder::BlindHoleStockBuilder ( )

Returns the blind hole stock builder (inheritable double)
Created in NX5.0.0.

License requirements : None

bool NXOpen::CAM::HoleMakingBuilder::CheckFluteLength ( )

Returns the check flute length flag
Created in NX5.0.0.

License requirements : None

bool NXOpen::CAM::HoleMakingBuilder::CheckToolLength ( )

Returns the check tool length flag
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::HoleMakingBuilder::ClrDistBuilder ( )

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

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::HoleMakingBuilder::ClrVertBuilder ( )

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

License requirements : None

NXOpen::CAM::HoleMakingBuilder::ControlPointTypes NXOpen::CAM::HoleMakingBuilder::ControlPointType ( )

Returns the control point type
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::CutParameters* NXOpen::CAM::HoleMakingBuilder::CutParameters ( )

Returns the cut parameter object
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::HoleMakingBuilder::EngageFeedRate ( )

Returns the Engage Feed Rate
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::FeedsBuilder* NXOpen::CAM::HoleMakingBuilder::FeedsBuilder ( )

Returns the feeds and speeds builder
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::HoleMakingBuilder::ModelDepthTypes NXOpen::CAM::HoleMakingBuilder::ModelDepthType ( )

Returns the model depth type
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::HoleMakingBuilder::OversizeToolPercentBuilder ( )

Returns the oversize tool percent builder (inheritable double)
Created in NX5.0.0.

License requirements : None

double NXOpen::CAM::HoleMakingBuilder::RapidFeedRate ( )

Returns the Rapid Feed Rate
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::HoleMakingBuilder::RaptoOffsetBuilder ( )

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

License requirements : None

bool NXOpen::CAM::HoleMakingBuilder::RaptoOffsetToggle ( )

Returns the rapto offset flag
Created in NX5.0.0.

License requirements : None

void NXOpen::CAM::HoleMakingBuilder::SetAllowOversizeTool ( bool allowOversize )

Sets the Allow Oversize Tool flag
Created in NX5.0.0.