NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Die::PierceTaskBuilder Class Reference

Represents a Pierce Task feature builder
To create a new instance of this class, use Die::DieCollection::PierceTask

Created in NX4.0.0. More...

Inheritance diagram for NXOpen::Die::PierceTaskBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  CamTypes { CamTypesDirect = 2, CamTypesAerial = 0, CamTypesBaseMounted }
 Settings for the cam type of the pierce task. More...
enum  CenterPointOptionTypes { CenterPointOptionTypesNone, CenterPointOptionTypesDie, CenterPointOptionTypesProduct, CenterPointOptionTypesBoth }
 Settings for the center point output options of the pierce task. More...
enum  PrecisionTypes { PrecisionTypesGage, PrecisionTypesCritical, PrecisionTypesStandard }
 Settings for the precistion type of the pierce task. More...

Public Member Functions

double AngleTolerance ()
 Returns the angle tolerance of the pierce task
Created in NX4.0.0.
NXOpen::SelectNXObjectListAssociatedObjects ()
 Returns the assoc objects
Created in NX5.0.0.
NXOpen::ILocationCamDirection ()
 Returns the cam direction of the pierce task
Created in NX4.0.0.
NXOpen::Die::PierceTaskBuilder::CamTypes CamType ()
 Returns the cam type of the pierce task
Created in NX4.0.0.
NXOpen::Die::PierceTaskBuilder::CenterPointOptionTypes CenterPointOption ()
 Returns the center point output option of the pierce task
Created in NX5.0.0.
bool CreateScrap ()
 Returns the create scrap setting of the pierce task.
double DistanceTolerance ()
 Returns the distance tolerance of the pierce task
Created in NX4.0.0.
bool FinishOperation ()
 Returns the finish operation of the pierce task True indicates the pierce is to be a finish pierce.
std::vector
< NXOpen::DisplayableObject * > 
GetAssociativeObjects ()
 Gets the associative objects of the pierce task.
std::vector< NXStringGetCameraLayerAndXmlp (std::vector< NXString > &xmlpData)
 Gets the camera layer settings and xmlp data.
std::vector< NXStringGetCameraNames ()
 Gets the names of the camera.
std::vector< NXOpen::View * > GetCameraViews ()
 Gets the camera views of the pierce task.
std::vector< NXStringGetDetails ()
 Gets the detailed description of the pierce task.
std::vector< NXOpen::IProfile * > GetPierceBounds (NXOpen::Die::DirectionOption *direction)
 Gets the pierce bounds of the pierce task.
bool LayoutFlange ()
 Returns the layout flange setting of the pierce task.
NXOpen::Die::PierceItemBuilderNewPierceHole (NXOpen::Die::PierceItemBuilder::HoleShapeType holeShape)
 Creates a new pierce hole item in the set.
NXOpen::ScCollectorPierceHoles ()
 Returns the pierce holes
Created in NX5.0.0.
NXOpen::Die::PierceItemBuilderListPierceHolesList ()
 Returns the pierce holes list
Created in NX5.0.0.
NXOpen::Die::PierceTaskBuilder::PrecisionTypes PrecisionType ()
 Returns the precision type of the pierce task
Created in NX4.0.0.
void SetAngleTolerance (double angleTolerance)
 Sets the angle tolerance of the pierce task
Created in NX4.0.0.
void SetAssociativeObjects (const std::vector< NXOpen::DisplayableObject * > &objects)
 Sets the associative objects of the pierce task
Created in NX4.0.0.
void SetCamDirection (NXOpen::ILocation *camDirection)
 Sets the cam direction of the pierce task
Created in NX4.0.0.
void SetCameraLayerAndXmlp (std::vector< NXString > &layerSettings, std::vector< NXString > &xmlpData)
 Sets the camera layer settings and xmlp data
Created in NX4.0.0.
void SetCameraNames (std::vector< NXString > &strings)
 Sets the names of the camera
Created in NX4.0.0.
void SetCameraViews (const std::vector< NXOpen::View * > &objects)
 Sets the camera views of the pierce task
Created in NX4.0.0.
void SetCamType (NXOpen::Die::PierceTaskBuilder::CamTypes camType)
 Sets the cam type of the pierce task
Created in NX4.0.0.
void SetCenterPointOption (NXOpen::Die::PierceTaskBuilder::CenterPointOptionTypes centerPointOption)
 Sets the center point output option of the pierce task
Created in NX5.0.0.
void SetCreateScrap (bool createScrap)
 Sets the create scrap setting of the pierce task.
void SetDetails (std::vector< NXString > &strings)
 Sets the detailed description of the pierce task
Created in NX4.0.0.
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance of the pierce task
Created in NX4.0.0.
void SetFinishOperation (bool finishOperation)
 Sets the finish operation of the pierce task True indicates the pierce is to be a finish pierce.
void SetLayoutFlange (bool layoutFlange)
 Sets the layout flange setting of the pierce task.
void SetPierceBounds (NXOpen::Die::DirectionOption direction, const std::vector< NXOpen::IProfile * > &profileEntries)
 Sets the pierce bounds of the pierce task.
void SetPrecisionType (NXOpen::Die::PierceTaskBuilder::PrecisionTypes precisionType)
 Sets the precision type of the pierce task
Created in NX4.0.0.
void SetTippedProduct (NXOpen::Features::Feature *tippedProduct)
 Sets the tipped product of the pierce task
Created in NX4.0.0.
NXOpen::Features::SelectFeatureTipFeature ()
 Returns the tip feature
Created in NX5.0.0.
NXOpen::Features::FeatureTippedProduct ()
 Returns the tipped product of the pierce task
Created in NX4.0.0.

Detailed Description

Represents a Pierce Task feature builder
To create a new instance of this class, use Die::DieCollection::PierceTask

Created in NX4.0.0.



Member Enumeration Documentation

Settings for the cam type of the pierce task.

Enumerator:
CamTypesBaseMounted 

Base Mounted Cam.

Settings for the center point output options of the pierce task.

Enumerator:
CenterPointOptionTypesNone 

No center points output.

CenterPointOptionTypesDie 

Center points output in die position.

CenterPointOptionTypesProduct 

Center points output in product position.

CenterPointOptionTypesBoth 

Center points output in both die and product position.

Settings for the precistion type of the pierce task.

Enumerator:
PrecisionTypesGage 

Gage hole.

PrecisionTypesCritical 

Critical hole.

PrecisionTypesStandard 

Standard hole.


Member Function Documentation

Returns the angle tolerance of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the assoc objects
Created in NX5.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the cam direction of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the cam type of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the center point output option of the pierce task
Created in NX5.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the create scrap setting of the pierce task.

True indicates that the scrap is to be created.
Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Returns the distance tolerance of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the finish operation of the pierce task True indicates the pierce is to be a finish pierce.

False indicates rough pierce.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Gets the associative objects of the pierce task.

Returns:

Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")
std::vector<NXString> NXOpen::Die::PierceTaskBuilder::GetCameraLayerAndXmlp ( std::vector< NXString > &  xmlpData)

Gets the camera layer settings and xmlp data.

Returns:
1 layer setting string for each camera object. the string needs to be 256 characters long (one for each user layer) with either 0 for off or 1 for on.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")
Parameters:
xmlpDataxmlp data

Gets the names of the camera.

Returns:
each string contains the name of a camera object
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Gets the camera views of the pierce task.

Returns:

Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Gets the detailed description of the pierce task.

Returns:
detail strings
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Gets the pierce bounds of the pierce task.

Returns:
Profile entries that make up the boundary of the pierce task
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")
Parameters:
directionProfile direction

Returns the layout flange setting of the pierce task.

True indicates that the pierce curve is to be laid out on the flange.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Creates a new pierce hole item in the set.

Returns:

Created in NX5.0.0.

License requirements : die_engineering ("DIE ENGINEERING")
Parameters:
holeShapehole shape

Returns the pierce holes
Created in NX5.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the pierce holes list
Created in NX5.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the precision type of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

void NXOpen::Die::PierceTaskBuilder::SetAngleTolerance ( double  angleTolerance)

Sets the angle tolerance of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
angleToleranceangle tolerance

Sets the associative objects of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
objectsobjects

Sets the cam direction of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
camDirectioncam direction
void NXOpen::Die::PierceTaskBuilder::SetCameraLayerAndXmlp ( std::vector< NXString > &  layerSettings,
std::vector< NXString > &  xmlpData 
)

Sets the camera layer settings and xmlp data
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
layerSettings1 layer setting string for each camera object. the string needs to be 256 characters long (one for each user layer) with either 0 for off or 1 for on.
NOTE: The full Unicode character set is not supported for this parameter.
xmlpDataxmlp data
void NXOpen::Die::PierceTaskBuilder::SetCameraNames ( std::vector< NXString > &  strings)

Sets the names of the camera
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
stringseach string contains the name of a camera object
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Die::PierceTaskBuilder::SetCameraViews ( const std::vector< NXOpen::View * > &  objects)

Sets the camera views of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
objectsobjects

Sets the cam type of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
camTypecam type

Sets the center point output option of the pierce task
Created in NX5.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
centerPointOptioncenter point option

Sets the create scrap setting of the pierce task.

True indicates that the scrap is to be created.
Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
createScrapcreate scrap
void NXOpen::Die::PierceTaskBuilder::SetDetails ( std::vector< NXString > &  strings)

Sets the detailed description of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
stringsdetail strings
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Die::PierceTaskBuilder::SetDistanceTolerance ( double  distanceTolerance)

Sets the distance tolerance of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
distanceTolerancedistance tolerance

Sets the finish operation of the pierce task True indicates the pierce is to be a finish pierce.

False indicates rough pierce.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
finishOperationfinish operation

Sets the layout flange setting of the pierce task.

True indicates that the pierce curve is to be laid out on the flange.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
layoutFlangelayout flange
void NXOpen::Die::PierceTaskBuilder::SetPierceBounds ( NXOpen::Die::DirectionOption  direction,
const std::vector< NXOpen::IProfile * > &  profileEntries 
)

Sets the pierce bounds of the pierce task.

Note - Die::PierceTaskBuilder::SetTippedProduct needs to be called before this function.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
directionProfile direction
profileEntriesProfile entries that make up the boundary of the pierce task

Sets the precision type of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
precisionTypeprecision type

Sets the tipped product of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
tippedProductThe tip of the operation where the pierce task resides.

Returns the tip feature
Created in NX5.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the tipped product of the pierce task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")


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