NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Tooling::ReusablePocketBuilder Class Reference

Reusable pocket builder. More...

Inheritance diagram for NXOpen::Tooling::ReusablePocketBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

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. More...
 
void AddToolComponent (NXOpen::NXObject *component)
 Adds tool component. More...
 
bool AutoTarget ()
 Returns the flag specifying whether target is fetched automatically. More...
 
void BreakLink (NXOpen::NXObject *component)
 Breaks link. More...
 
void CreatePocket (NXOpen::NXObject *component)
 Creates pocket. More...
 
void DeletePocket (NXOpen::NXObject *component)
 Deletes pocket. More...
 
void RecreateHoleSeries (NXOpen::NXObject *component, NXOpen::NXObject *feature)
 Recreates hole series if hole feature is updated. More...
 
void RemoveTargetBody (NXOpen::NXObject *component, NXOpen::NXObject *targetBody)
 Removes target body. More...
 
void RemoveToolComponent (NXOpen::NXObject *component)
 Removes tool component. More...
 
void SetAutoTarget (bool autoTarget)
 Sets the flag specifying whether target is fetched automatically. More...
 
void SetCounterboreDiameter (NXOpen::NXObject *component, double counterboreDiameter)
 Sets counterbore diameter for hole series. More...
 
void SetCountersunkDiameter (NXOpen::NXObject *component, double countersunkDiameter)
 Sets countersunk diameter for hole series. More...
 
void SetDiameter (NXOpen::NXObject *component, double diameter)
 Sets diameter for hole series. More...
 
void SetFit (NXOpen::NXObject *component, const NXString &fit)
 Sets fit for hole series. More...
 
void SetFit (NXOpen::NXObject *component, const char *fit)
 Sets fit for hole series. More...
 
void SetForm (NXOpen::NXObject *component, const NXString &form)
 Sets form for hole series. More...
 
void SetForm (NXOpen::NXObject *component, const char *form)
 Sets form for hole series. More...
 
void SetHoleType (NXOpen::NXObject *component, NXOpen::Tooling::ReusablePocketBuilder::Hole holeType)
 Sets hole type. More...
 
void SetReference (NXOpen::NXObject *component, const NXString &reference)
 Sets reference set. More...
 
void SetReference (NXOpen::NXObject *component, const char *reference)
 Sets reference set. More...
 
void SetScrewType (NXOpen::NXObject *component, const NXString &screwType)
 Sets screw type for hole series. More...
 
void SetScrewType (NXOpen::NXObject *component, const char *screwType)
 Sets screw type for hole series. More...
 
void SetStandard (NXOpen::NXObject *component, const NXString &standard)
 Sets standard for hole series. More...
 
void SetStandard (NXOpen::NXObject *component, const char *standard)
 Sets standard for hole series. More...
 
void SetThreadHole (bool threadHole)
 Sets the flag specifying whether thread hole is used. More...
 
bool ThreadHole ()
 Returns the flag specifying whether thread hole is used. More...
 
void VerifyHoleSeries (NXOpen::NXObject *component)
 Verifies hole series parameters. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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

Reusable pocket builder.


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

Property Value

AutoTarget

true

ThreadHole

false


Created in NX7.5.0.

Member Enumeration Documentation

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
componentComponent to which target body is added
targetBodyTarget body
void NXOpen::Tooling::ReusablePocketBuilder::AddToolComponent ( NXOpen::NXObject component)

Adds tool component.


Created in NX7.5.0.

License requirements : None

Parameters
componentTool 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
componentComponent to which link is broke
void NXOpen::Tooling::ReusablePocketBuilder::CreatePocket ( NXOpen::NXObject component)

Creates pocket.


Created in NX7.5.0.

License requirements : None

Parameters
componentComponent to which pocket is created
void NXOpen::Tooling::ReusablePocketBuilder::DeletePocket ( NXOpen::NXObject component)

Deletes pocket.


Created in NX7.5.0.

License requirements : None

Parameters
componentComponent 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
componentComponent to recreate hole series
featureFeature 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
componentComponent to which target body is removed
targetBodyTarget body
void NXOpen::Tooling::ReusablePocketBuilder::RemoveToolComponent ( NXOpen::NXObject component)

Removes tool component.


Created in NX7.5.0.

License requirements : None

Parameters
componentTool 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
autoTargetautotarget
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
componentComponent to which counterbore diameter is set
counterboreDiameterC-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
componentComponent to which countersunk diameter is set
countersunkDiameterC-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
componentComponent to which diameter is set
diameterDiameter 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
componentComponent to which fit is set
fitHole series fit
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
componentComponent to which fit is set
fitHole series fit
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
componentComponent to which form is set
formHole series form
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
componentComponent to which form is set
formHole series form
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
componentComponent to which hole type is set
holeTypeHole type
void NXOpen::Tooling::ReusablePocketBuilder::SetReference ( NXOpen::NXObject component,
const NXString reference 
)

Sets reference set.


Created in NX7.5.0.

License requirements : None

Parameters
componentComponent to which reference is set
referenceReference set with cut body
void NXOpen::Tooling::ReusablePocketBuilder::SetReference ( NXOpen::NXObject component,
const char *  reference 
)

Sets reference set.


Created in NX7.5.0.

License requirements : None

Parameters
componentComponent to which reference is set
referenceReference set with cut body
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
componentComponent to which screw type is set
screwTypeHole series screw type
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
componentComponent to which screw type is set
screwTypeHole series screw type
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
componentComponent to which standard is set
standardHole series standard
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
componentComponent to which standard is set
standardHole series standard
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
threadHolethreadhole
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
componentComponent to verify hole series parameters

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.