Reusable pocket builder. More...

Inheritance diagram for NXOpen::Tooling::ReusablePocketBuilder:

Public Types
enum	Hole { HoleSeries, HoleSubtract, HoleNone }
	Represents hole types. More...

Public Member Functions
void	AddTargetBody (NXOpen::NXObject component, NXOpen::NXObject targetBody)
	Adds target body.

void	AddToolComponent (NXOpen::NXObject *component)
	Adds tool component.

bool	AutoTarget ()
	Returns the flag specifying whether target is fetched automatically.

void	BreakLink (NXOpen::NXObject *component)
	Breaks link.

void	CreatePocket (NXOpen::NXObject *component)
	Creates pocket.

void	DeletePocket (NXOpen::NXObject *component)
	Deletes pocket.

void	RecreateHoleSeries (NXOpen::NXObject component, NXOpen::NXObject feature)
	Recreates hole series if hole feature is updated.

void	RemoveTargetBody (NXOpen::NXObject component, NXOpen::NXObject targetBody)
	Removes target body.

void	RemoveToolComponent (NXOpen::NXObject *component)
	Removes tool component.

void	SetAutoTarget (bool autoTarget)
	Sets the flag specifying whether target is fetched automatically.

void	SetCounterboreDiameter (NXOpen::NXObject *component, double counterboreDiameter)
	Sets counterbore diameter for hole series.

void	SetCountersunkDiameter (NXOpen::NXObject *component, double countersunkDiameter)
	Sets countersunk diameter for hole series.

void	SetDiameter (NXOpen::NXObject *component, double diameter)
	Sets diameter for hole series.

void	SetFit (NXOpen::NXObject *component, const NXString &fit)
	Sets fit for hole series.

void	SetFit (NXOpen::NXObject component, const char fit)
	Sets fit for hole series.

void	SetForm (NXOpen::NXObject *component, const NXString &form)
	Sets form for hole series.

void	SetForm (NXOpen::NXObject component, const char form)
	Sets form for hole series.

void	SetHoleType (NXOpen::NXObject *component, NXOpen::Tooling::ReusablePocketBuilder::Hole holeType)
	Sets hole type.

void	SetReference (NXOpen::NXObject *component, const NXString &reference)
	Sets reference set.

void	SetReference (NXOpen::NXObject component, const char reference)
	Sets reference set.

void	SetScrewType (NXOpen::NXObject *component, const NXString &screwType)
	Sets screw type for hole series.

void	SetScrewType (NXOpen::NXObject component, const char screwType)
	Sets screw type for hole series.

void	SetStandard (NXOpen::NXObject *component, const NXString &standard)
	Sets standard for hole series.

void	SetStandard (NXOpen::NXObject component, const char standard)
	Sets standard for hole series.

void	SetThreadHole (bool threadHole)
	Sets the flag specifying whether thread hole is used.

bool	ThreadHole ()
	Returns the flag specifying whether thread hole is used.

void	VerifyHoleSeries (NXOpen::NXObject *component)
	Verifies hole series parameters.

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

Reusable pocket builder.

To create a new instance of this class, use Tooling::ReusablePocketCollection::CreateReusablePocketBuilder
Default values.

Property

Value

AutoTarget

true

ThreadHole

false

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::Tooling::ReusablePocketBuilder::Hole

Represents hole types.

Enumerator:

HoleSeries	Pocket with hole series.
HoleSubtract	Subtract pocket.
HoleNone	None.

Member Function Documentation

void NXOpen::Tooling::ReusablePocketBuilder::AddTargetBody	(	NXOpen::NXObject *	component,
		NXOpen::NXObject *	targetBody
	)

Adds target body.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which target body is added
targetBody	Target body

void NXOpen::Tooling::ReusablePocketBuilder::AddToolComponent ( NXOpen::NXObject * component )

Adds tool component.

Created in NX7.5.0.

License requirements : None

Parameters

component Tool component

bool NXOpen::Tooling::ReusablePocketBuilder::AutoTarget ( )

Returns the flag specifying whether target is fetched automatically.

       If true, the target is fetched automatically, 
       else, the target is fetched manually.

Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::ReusablePocketBuilder::BreakLink ( NXOpen::NXObject * component )

Breaks link.

Created in NX8.0.0.

License requirements : None

Parameters

component Component to which link is broke

void NXOpen::Tooling::ReusablePocketBuilder::CreatePocket ( NXOpen::NXObject * component )

Creates pocket.

Created in NX7.5.0.

License requirements : None

Parameters

component Component to which pocket is created

void NXOpen::Tooling::ReusablePocketBuilder::DeletePocket ( NXOpen::NXObject * component )

Deletes pocket.

Created in NX7.5.0.

License requirements : None

Parameters

component Component to which pocket is deleted

void NXOpen::Tooling::ReusablePocketBuilder::RecreateHoleSeries	(	NXOpen::NXObject *	component,
		NXOpen::NXObject *	feature
	)

Recreates hole series if hole feature is updated.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to recreate hole series
feature	Feature to be recreated

void NXOpen::Tooling::ReusablePocketBuilder::RemoveTargetBody	(	NXOpen::NXObject *	component,
		NXOpen::NXObject *	targetBody
	)

Removes target body.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which target body is removed
targetBody	Target body

void NXOpen::Tooling::ReusablePocketBuilder::RemoveToolComponent ( NXOpen::NXObject * component )

Removes tool component.

Created in NX7.5.0.

License requirements : None

Parameters

component Tool component to remove

void NXOpen::Tooling::ReusablePocketBuilder::SetAutoTarget ( bool autoTarget )

Sets the flag specifying whether target is fetched automatically.

       If true, the target is fetched automatically, 
       else, the target is fetched manually.

Created in NX7.5.0.

License requirements : None

Parameters

autoTarget autotarget

void NXOpen::Tooling::ReusablePocketBuilder::SetCounterboreDiameter	(	NXOpen::NXObject *	component,
		double	counterboreDiameter
	)

Sets counterbore diameter for hole series.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which counterbore diameter is set
counterboreDiameter	C-Bore diameter for hole series

void NXOpen::Tooling::ReusablePocketBuilder::SetCountersunkDiameter	(	NXOpen::NXObject *	component,
		double	countersunkDiameter
	)

Sets countersunk diameter for hole series.

Created in NX8.0.0.

License requirements : None

Parameters

component	Component to which countersunk diameter is set
countersunkDiameter	C-Sink diameter for hole series

void NXOpen::Tooling::ReusablePocketBuilder::SetDiameter	(	NXOpen::NXObject *	component,
		double	diameter
	)

Sets diameter for hole series.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which diameter is set
diameter	Diameter for hole series

void NXOpen::Tooling::ReusablePocketBuilder::SetFit	(	NXOpen::NXObject *	component,
		const NXString &	fit
	)

Sets fit for hole series.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which fit is set
fit	Hole series fit NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Tooling::ReusablePocketBuilder::SetFit	(	NXOpen::NXObject *	component,
		const char *	fit
	)

Sets fit for hole series.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which fit is set
fit	Hole series fit NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Tooling::ReusablePocketBuilder::SetForm	(	NXOpen::NXObject *	component,
		const NXString &	form
	)

Sets form for hole series.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which form is set
form	Hole series form NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Tooling::ReusablePocketBuilder::SetForm	(	NXOpen::NXObject *	component,
		const char *	form
	)

Sets form for hole series.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which form is set
form	Hole series form NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Tooling::ReusablePocketBuilder::SetHoleType	(	NXOpen::NXObject *	component,
		NXOpen::Tooling::ReusablePocketBuilder::Hole	holeType
	)

Sets hole type.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which hole type is set
holeType	Hole type

void NXOpen::Tooling::ReusablePocketBuilder::SetReference	(	NXOpen::NXObject *	component,
		const NXString &	reference
	)

Sets reference set.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which reference is set
reference	Reference set with cut body NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Tooling::ReusablePocketBuilder::SetReference	(	NXOpen::NXObject *	component,
		const char *	reference
	)

Sets reference set.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which reference is set
reference	Reference set with cut body NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Tooling::ReusablePocketBuilder::SetScrewType	(	NXOpen::NXObject *	component,
		const NXString &	screwType
	)

Sets screw type for hole series.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which screw type is set
screwType	Hole series screw type NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Tooling::ReusablePocketBuilder::SetScrewType	(	NXOpen::NXObject *	component,
		const char *	screwType
	)

Sets screw type for hole series.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which screw type is set
screwType	Hole series screw type NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Tooling::ReusablePocketBuilder::SetStandard	(	NXOpen::NXObject *	component,
		const NXString &	standard
	)

Sets standard for hole series.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which standard is set
standard	Hole series standard NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Tooling::ReusablePocketBuilder::SetStandard	(	NXOpen::NXObject *	component,
		const char *	standard
	)

Sets standard for hole series.

Created in NX7.5.0.

License requirements : None

Parameters

component	Component to which standard is set
standard	Hole series standard NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Tooling::ReusablePocketBuilder::SetThreadHole ( bool threadHole )

Sets the flag specifying whether thread hole is used.

       If true, thread hole is used, 
       else, screw clearance hole is used.

Created in NX7.5.0.

License requirements : None

Parameters

threadHole threadhole

bool NXOpen::Tooling::ReusablePocketBuilder::ThreadHole ( )

Returns the flag specifying whether thread hole is used.

       If true, thread hole is used, 
       else, screw clearance hole is used.

Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::ReusablePocketBuilder::VerifyHoleSeries ( NXOpen::NXObject * component )

Verifies hole series parameters.

Created in NX7.5.0.

License requirements : None

Parameters

component Component to verify hole series parameters

The documentation for this class was generated from the following file:

Tooling_ReusablePocketBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation