Represents a CAM geometry builder
This is an abstract class and cannot be instantiated. More...

Inheritance diagram for NXOpen::CAM::HoleBossGeom:

Public Types
enum	DepthLimitTypes { DepthLimitTypesThrough, DepthLimitTypesBlind, DepthLimitTypesUnknown }
	the depth limit types More...

enum	FormPitchTypes { FormPitchTypesSpecify, FormPitchTypesFromTable, FormPitchTypesFromTool, FormPitchTypesFromModel }
	the form and pitch types Created in NX7.5.0. More...

enum	FormTypes { FormTypesUnified, FormTypesMetric, FormTypesTrapezoidal, FormTypesAcme, FormTypesStubAcme, FormTypesLowernherz, FormTypesButtress, FormTypesSparkPlug, FormTypesNpt, FormTypesHoseCoupling, FormTypesFireHose, FormTypesUnj, FormTypesNps, FormTypesBsp, FormTypesBstp, FormTypesHelicoil, FormTypesNs, FormTypesUserDefined }
	the Form types Created in NX7.5.0. More...

enum	HoleBossTypes { HoleBossTypesHole, HoleBossTypesBoss, HoleBossTypesThreadedHole, HoleBossTypesThreadedBoss, HoleBossTypesCenterHole, HoleBossTypesChamferHole }
	the hole or boss types Created in NX7.5.0. More...

enum	OptimizationTypes { OptimizationTypesClosest, OptimizationTypesShortestPath }
	the optimization types Created in NX8.0.0. More...

enum	RotationTypes { RotationTypesRightHand, RotationTypesLeftHand }
	the rotation types Created in NX7.5.0. More...

Public Member Functions
NXOpen::CAM::HoleBossSetList *	BossList ()
	Returns the boss list Created in NX8.0.0.

NXOpen::CAM::HoleBossSet *	CreateHoleBossBuilder (const std::vector< NXOpen::NXObject * > &entities, double diameter, double depth, NXOpen::NXObject *toolAxis, int depthLimit)
	Create a new Hole or Boss.

NXOpen::CAM::ThreadedBossSet *	CreateThreadedBossBuilder (const std::vector< NXOpen::NXObject * > &entities, double diameter, double height, NXOpen::NXObject *toolAxis, double majorDiameter, double minorDiameter, double lengh, const NXString &size, double pitch, int rotation, NXOpen::CAM::HoleBossGeom::FormTypes form, const NXString &formUserDefined)
	Create a new Thread Boss.

NXOpen::CAM::ThreadedBossSet *	CreateThreadedBossBuilder (const std::vector< NXOpen::NXObject * > &entities, double diameter, double height, NXOpen::NXObject toolAxis, double majorDiameter, double minorDiameter, double lengh, const char size, double pitch, int rotation, NXOpen::CAM::HoleBossGeom::FormTypes form, const char *formUserDefined)
	Create a new Thread Boss.

NXOpen::CAM::ThreadedHoleSet *	CreateThreadedHoleBuilder (const std::vector< NXOpen::NXObject * > &entities, double tapDrillSize, double depth, NXOpen::NXObject *toolAxis, double majorDiameter, double minorDiameter, double lengh, const NXString &size, const NXString &radialEngage, double pitch, int rotation, NXOpen::CAM::HoleBossGeom::FormTypes form, const NXString &formUserDefined, const NXString &tableStandard, int depthLimit)
	Create a new Thread Hole.

NXOpen::CAM::ThreadedHoleSet *	CreateThreadedHoleBuilder (const std::vector< NXOpen::NXObject * > &entities, double tapDrillSize, double depth, NXOpen::NXObject toolAxis, double majorDiameter, double minorDiameter, double lengh, const char size, const char radialEngage, double pitch, int rotation, NXOpen::CAM::HoleBossGeom::FormTypes form, const char formUserDefined, const char *tableStandard, int depthLimit)
	Create a new Thread Hole.

NXOpen::CAM::HoleBossGeom::DepthLimitTypes	DepthLimit ()
	Returns the Depth Limit types

NXOpen::CAM::HoleBossGeom::FormPitchTypes	FormAndPitch ()
	Returns the Form and Pitch types Created in NX7.5.0.

NXOpen::CAM::FBM::MachiningFeatureGeometry *	GetCenterHoleGeometry ()
	Get the center hole builder.

NXOpen::CAM::FBM::MachiningFeatureGeometry *	GetChamferHoleGeometry ()
	Get the chamfer hole builder.

void	GetForm (NXOpen::CAM::HoleBossGeom::FormTypes type, NXString formCustom)
	The Form types.

NXOpen::CAM::HoleBossGeom::HoleBossTypes	HoleBossGeomType ()
	Returns the hole or boss types Created in NX7.5.0.

NXOpen::CAM::HoleBossSetList *	HoleList ()
	Returns the hole list Created in NX8.0.0.

NXOpen::CAM::HoleBossGeom::OptimizationTypes	Optimization ()
	Returns the optimization types Created in NX8.0.0.

double	Pitch ()
	Returns the Pitch Created in NX7.5.0.

void	ReorderList ()
	Reverses the direction of the feature Created in NX8.0.0.

NXOpen::CAM::HoleBossGeom::RotationTypes	Rotation ()
	Returns the Rotation types Created in NX7.5.0.

NXOpen::SelectTaggedObject *	Selection ()
	Returns the selection geometry Created in NX7.5.0.

void	SetDepthLimit (NXOpen::CAM::HoleBossGeom::DepthLimitTypes type)
	Sets the Depth Limit types

void	SetForm (NXOpen::CAM::HoleBossGeom::FormTypes type, const NXString &formCustom)
	The Form types.

void	SetForm (NXOpen::CAM::HoleBossGeom::FormTypes type, const char *formCustom)
	The Form types.

void	SetFormAndPitch (NXOpen::CAM::HoleBossGeom::FormPitchTypes type)
	Sets the Form and Pitch types Created in NX7.5.0.

void	SetHoleBossGeomType (NXOpen::CAM::HoleBossGeom::HoleBossTypes type)
	Sets the hole or boss types Created in NX7.5.0.

void	SetOptimization (NXOpen::CAM::HoleBossGeom::OptimizationTypes type)
	Sets the optimization types Created in NX8.0.0.

void	SetPitch (double holeBossValue)
	Sets the Pitch Created in NX7.5.0.

void	SetRotation (NXOpen::CAM::HoleBossGeom::RotationTypes type)
	Sets the Rotation types Created in NX7.5.0.

NXOpen::CAM::ThreadedBossSetList *	ThreadedBossList ()
	Returns the threaded boss list Created in NX7.5.0.

NXOpen::CAM::ThreadedHoleSetList *	ThreadedHoleList ()
	Returns the threaded hole list Created in NX7.5.0.

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 CAM geometry builder
This is an abstract class and cannot be instantiated.

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::CAM::HoleBossGeom::DepthLimitTypes

the depth limit types

Deprecated:: Deprecated in NX8.0.0.

The property that used this enum is replaced by CAM::HoleBossSet::DepthLimit .

Created in NX7.5.0.

Enumerator:

DepthLimitTypesThrough

Depth Limit: Through.

DepthLimitTypesBlind

Depth Limit: Blind.

DepthLimitTypesUnknown

It maybe mixed type with both Through and Blind features in NX8.

Please use HoleBossSet builder to get the type

enum NXOpen::CAM::HoleBossGeom::FormPitchTypes

the form and pitch types
Created in NX7.5.0.

Enumerator:

FormPitchTypesSpecify	Form and Pitch: Specify.
FormPitchTypesFromTable	Form and Pitch: From Table.
FormPitchTypesFromTool	Form and Pitch: From Tool.
FormPitchTypesFromModel	Form and Pitch: From Model.

enum NXOpen::CAM::HoleBossGeom::FormTypes

the Form types
Created in NX7.5.0.

Enumerator:

FormTypesUnified	Form: Unified.
FormTypesMetric	Form: Metric.
FormTypesTrapezoidal	Form: Trapezoidal.
FormTypesAcme	Form: Acme.
FormTypesStubAcme	Form: Stub Acme.
FormTypesLowernherz	Form: Lowenherz.
FormTypesButtress	Form: Buttress.
FormTypesSparkPlug	Form: Spark Plug.
FormTypesNpt	Form: NPT.
FormTypesHoseCoupling	Form: Hose Coupling.
FormTypesFireHose	Form: Fire Hose.
FormTypesUnj	Form: UNJ.
FormTypesNps	Form: NPS.
FormTypesBsp	Form: BSP.
FormTypesBstp	Form: BSTP.
FormTypesHelicoil	Form: Helicoil.
FormTypesNs	Form: NS.
FormTypesUserDefined	Form: User-defined.

enum NXOpen::CAM::HoleBossGeom::HoleBossTypes

the hole or boss types
Created in NX7.5.0.

Enumerator:

HoleBossTypesHole	Type: Hole.
HoleBossTypesBoss	Type: Boss.
HoleBossTypesThreadedHole	Type: Threaded Hole.
HoleBossTypesThreadedBoss	Type: Threaded Boss.
HoleBossTypesCenterHole	Type: Center Hole.
HoleBossTypesChamferHole	Type: Chamfer Hole.

enum NXOpen::CAM::HoleBossGeom::OptimizationTypes

the optimization types
Created in NX8.0.0.

Enumerator:

OptimizationTypesClosest	Optimization: Closet.
OptimizationTypesShortestPath	Optimization: Shortest Path.

enum NXOpen::CAM::HoleBossGeom::RotationTypes

the rotation types
Created in NX7.5.0.

Enumerator:

RotationTypesRightHand	Rotation: Right-hand.
RotationTypesLeftHand	Rotation: Left-hand.

Member Function Documentation

NXOpen::CAM::HoleBossSetList* NXOpen::CAM::HoleBossGeom::BossList ( )

Returns the boss list
Created in NX8.0.0.

License requirements : None

NXOpen::CAM::HoleBossSet* NXOpen::CAM::HoleBossGeom::CreateHoleBossBuilder	(	const std::vector< NXOpen::NXObject * > &	entities,
		double	diameter,
		double	depth,
		NXOpen::NXObject *	toolAxis,
		int	depthLimit
	)

Create a new Hole or Boss.

Returns: the Hole or Boss Set builder
Created in NX8.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

entities	the geometry
diameter	the diameter
depth	the depth
toolAxis	the tool axis
depthLimit	the depth limit

NXOpen::CAM::ThreadedBossSet* NXOpen::CAM::HoleBossGeom::CreateThreadedBossBuilder	(	const std::vector< NXOpen::NXObject * > &	entities,
		double	diameter,
		double	height,
		NXOpen::NXObject *	toolAxis,
		double	majorDiameter,
		double	minorDiameter,
		double	lengh,
		const NXString &	size,
		double	pitch,
		int	rotation,
		NXOpen::CAM::HoleBossGeom::FormTypes	form,
		const NXString &	formUserDefined
	)

Create a new Thread Boss.

Returns: the Thread Boss Set builder
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

entities	the geometry
diameter	the diameter
height	the height
toolAxis	the tool axis
majorDiameter	the major diameter
minorDiameter	the minor diameter
lengh	the lengh
size	the size title NOTE: The full Unicode character set is not supported for this parameter.
pitch	the pitch
rotation	the rotation
form	the form
formUserDefined	the user defined Form NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::CAM::ThreadedBossSet* NXOpen::CAM::HoleBossGeom::CreateThreadedBossBuilder	(	const std::vector< NXOpen::NXObject * > &	entities,
		double	diameter,
		double	height,
		NXOpen::NXObject *	toolAxis,
		double	majorDiameter,
		double	minorDiameter,
		double	lengh,
		const char *	size,
		double	pitch,
		int	rotation,
		NXOpen::CAM::HoleBossGeom::FormTypes	form,
		const char *	formUserDefined
	)

Create a new Thread Boss.

Returns: the Thread Boss Set builder
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

entities	the geometry
diameter	the diameter
height	the height
toolAxis	the tool axis
majorDiameter	the major diameter
minorDiameter	the minor diameter
lengh	the lengh
size	the size title NOTE: The full Unicode character set is not supported for this parameter.
pitch	the pitch
rotation	the rotation
form	the form
formUserDefined	the user defined Form NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::CAM::ThreadedHoleSet* NXOpen::CAM::HoleBossGeom::CreateThreadedHoleBuilder	(	const std::vector< NXOpen::NXObject * > &	entities,
		double	tapDrillSize,
		double	depth,
		NXOpen::NXObject *	toolAxis,
		double	majorDiameter,
		double	minorDiameter,
		double	lengh,
		const NXString &	size,
		const NXString &	radialEngage,
		double	pitch,
		int	rotation,
		NXOpen::CAM::HoleBossGeom::FormTypes	form,
		const NXString &	formUserDefined,
		const NXString &	tableStandard,
		int	depthLimit
	)

Create a new Thread Hole.

Returns: the Thread Hole Set builder
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

entities	the geometry
tapDrillSize	the tap drill size
depth	the depth
toolAxis	the tool axis
majorDiameter	the major diameter
minorDiameter	the minor diameter
lengh	the lengh
size	the size NOTE: The full Unicode character set is not supported for this parameter.
radialEngage	the radial engage NOTE: The full Unicode character set is not supported for this parameter.
pitch	the pitch
rotation	the rotation
form	the form
formUserDefined	the user defined Form NOTE: The full Unicode character set is not supported for this parameter.
tableStandard	the Standard NOTE: The full Unicode character set is not supported for this parameter.
depthLimit	the depth limit

NXOpen::CAM::ThreadedHoleSet* NXOpen::CAM::HoleBossGeom::CreateThreadedHoleBuilder	(	const std::vector< NXOpen::NXObject * > &	entities,
		double	tapDrillSize,
		double	depth,
		NXOpen::NXObject *	toolAxis,
		double	majorDiameter,
		double	minorDiameter,
		double	lengh,
		const char *	size,
		const char *	radialEngage,
		double	pitch,
		int	rotation,
		NXOpen::CAM::HoleBossGeom::FormTypes	form,
		const char *	formUserDefined,
		const char *	tableStandard,
		int	depthLimit
	)

Create a new Thread Hole.

Returns: the Thread Hole Set builder
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

entities	the geometry
tapDrillSize	the tap drill size
depth	the depth
toolAxis	the tool axis
majorDiameter	the major diameter
minorDiameter	the minor diameter
lengh	the lengh
size	the size NOTE: The full Unicode character set is not supported for this parameter.
radialEngage	the radial engage NOTE: The full Unicode character set is not supported for this parameter.
pitch	the pitch
rotation	the rotation
form	the form
formUserDefined	the user defined Form NOTE: The full Unicode character set is not supported for this parameter.
tableStandard	the Standard NOTE: The full Unicode character set is not supported for this parameter.
depthLimit	the depth limit

NXOpen::CAM::HoleBossGeom::DepthLimitTypes NXOpen::CAM::HoleBossGeom::DepthLimit ( )

Returns the Depth Limit types

Deprecated:: Deprecated in NX8.0.0.

Use CAM::HoleBossSet::DepthLimit instead.

Created in NX7.5.0.

License requirements : None

NXOpen::CAM::HoleBossGeom::FormPitchTypes NXOpen::CAM::HoleBossGeom::FormAndPitch ( )

Returns the Form and Pitch types
Created in NX7.5.0.

License requirements : None

NXOpen::CAM::FBM::MachiningFeatureGeometry* NXOpen::CAM::HoleBossGeom::GetCenterHoleGeometry ( )

Get the center hole builder.

Returns: the center hole builder
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::FBM::MachiningFeatureGeometry* NXOpen::CAM::HoleBossGeom::GetChamferHoleGeometry ( )

Get the chamfer hole builder.

Returns: the center hole builder
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::HoleBossGeom::GetForm	(	NXOpen::CAM::HoleBossGeom::FormTypes *	type,
		NXString *	formCustom
	)

The Form types.

       When the Form type is user defined, it will return the Form type(UserDefined) and User Defined Name;
       When the Form type is NOT user defined, it will return the Form type and the formCustom is NULL.

Created in NX7.5.0.

License requirements : None

Parameters

type	the Form Standard type
formCustom	the User Defined Form

NXOpen::CAM::HoleBossGeom::HoleBossTypes NXOpen::CAM::HoleBossGeom::HoleBossGeomType ( )

Returns the hole or boss types
Created in NX7.5.0.

License requirements : None

NXOpen::CAM::HoleBossSetList* NXOpen::CAM::HoleBossGeom::HoleList ( )

Returns the hole list
Created in NX8.0.0.

License requirements : None

NXOpen::CAM::HoleBossGeom::OptimizationTypes NXOpen::CAM::HoleBossGeom::Optimization ( )

Returns the optimization types
Created in NX8.0.0.

License requirements : None

double NXOpen::CAM::HoleBossGeom::Pitch ( )

Returns the Pitch
Created in NX7.5.0.

License requirements : None

void NXOpen::CAM::HoleBossGeom::ReorderList ( )

Reverses the direction of the feature
Created in NX8.0.0.

License requirements : None

NXOpen::CAM::HoleBossGeom::RotationTypes NXOpen::CAM::HoleBossGeom::Rotation ( )

Returns the Rotation types
Created in NX7.5.0.

License requirements : None

NXOpen::SelectTaggedObject* NXOpen::CAM::HoleBossGeom::Selection ( )

Returns the selection geometry
Created in NX7.5.0.

License requirements : None

void NXOpen::CAM::HoleBossGeom::SetDepthLimit ( NXOpen::CAM::HoleBossGeom::DepthLimitTypes type )

Sets the Depth Limit types

Deprecated:: Deprecated in NX8.0.0.

Use CAM::HoleBossSet::SetDepthLimit instead.

Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

type	the Depth Limit type

void NXOpen::CAM::HoleBossGeom::SetForm	(	NXOpen::CAM::HoleBossGeom::FormTypes	type,
		const NXString &	formCustom
	)

The Form types.

       When the Form type is user defined, please set the Form type(UserDefined) and User Defined Name;
       When the Form type is NOT user defined, please set the Form type and let the formCustom NULL.

Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

type	the Form Standard type
formCustom	the User Defined Form NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::CAM::HoleBossGeom::SetForm	(	NXOpen::CAM::HoleBossGeom::FormTypes	type,
		const char *	formCustom
	)

The Form types.

       When the Form type is user defined, please set the Form type(UserDefined) and User Defined Name;
       When the Form type is NOT user defined, please set the Form type and let the formCustom NULL.

Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

type	the Form Standard type
formCustom	the User Defined Form NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::CAM::HoleBossGeom::SetFormAndPitch ( NXOpen::CAM::HoleBossGeom::FormPitchTypes type )

Sets the Form and Pitch types
Created in NX7.5.0.