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

Represents a Die Pad Child sub feature. More...

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

Public Types

enum  ShapeTypeOption { ShapeTypeOptionRectangular, ShapeTypeOptionCircular, ShapeTypeOptionCurve }
 Settings for the shape type of the die pad. More...
 

Public Member Functions

NXOpen::Die::DieBuildStatusOption BuildStatus ()
 Returns the build status of the die pad. More...
 
bool CenterHole ()
 Returns the center hole switch of the die pad, if true the center hole will be created in the pad, if false it will not. More...
 
bool DesignStatus ()
 Returns the design status of the die pad, if true the pad will be built into the model, if false it will not. More...
 
double Diameter ()
 Returns the diameter of the die pad. More...
 
bool DisplayStatus ()
 Returns the display status of the die pad, if true input data to the pad will be displayed, if false the input data will not be displayed. More...
 
void GetHoleAttributes (NXString *title, NXString *value, int *color, NXString *diameterTitle)
 Gets the hole attributes, note existance of attributes depends on usage in main feature. More...
 
std::vector< NXOpen::Point * > GetHoleCenters ()
 Gets the hole centers of the die pad. More...
 
void GetPadAttributes (NXString *title, NXString *value, int *color)
 Gets the pad attributes, note existance of attributes depends on usage in main feature. More...
 
void GetReliefAttributes (NXString *title, NXString *value, int *color)
 Gets the relief attributes, note existance of attributes depends on usage in main feature. More...
 
std::vector< NXOpen::IProfile * > GetShape (NXOpen::Die::DirectionOption *direction)
 Gets the shape profile of the die pads. More...
 
double Height ()
 Returns the height of the die pad. More...
 
double HoleDiameter ()
 Returns the hole diameter of the die pad. More...
 
double Length ()
 Returns the length of the die pad. More...
 
NXOpen::IOrientationLimitingSurface ()
 Returns the limiting surface of the die pad. More...
 
NXOpen::ILocationLocation ()
 Returns the location of the die pad. More...
 
double LocationOffset ()
 Returns the location offset of the die pad. More...
 
NXOpen::IReferenceAxisLocationOffsetDirection ()
 Returns the location offset direction of the die pad. More...
 
NXOpen::IOrientationOrientationPlane ()
 Returns the orientation plane of the die pad. More...
 
bool Relief ()
 Returns the relief switch of the die pad, if true the relief will be built around the pad, if false it will not. More...
 
double ReliefDepth ()
 Returns the relief depth of the die pad. More...
 
double ReliefWidth ()
 Returns the relief width of the die pad. More...
 
bool ReverseOrientation ()
 Returns the value to reverse the orientation of the orientation plane, if true the pad orientation normal will be reversed, if false it will not. More...
 
void SetCenterHole (bool centerHole)
 Sets the center hole switch of the die pad, if true the center hole will be created in the pad, if false it will not. More...
 
void SetDesignStatus (bool designStatus)
 Sets the design status of the die pad, if true the pad will be built into the model, if false it will not. More...
 
void SetDiameter (double diameter)
 Sets the diameter of the die pad. More...
 
void SetDisplayStatus (bool displayStatus)
 Sets the display status of the die pad, if true input data to the pad will be displayed, if false the input data will not be displayed. More...
 
void SetHeight (double height)
 Sets the height of the die pad. More...
 
void SetHoleAttributes (const NXString &title, const NXString &value, int color, const NXString &diameterTitle)
 Sets the hole attributes, note existance of attributes depends on usage in main feature. More...
 
void SetHoleAttributes (const char *title, const char *value, int color, const char *diameterTitle)
 Sets the hole attributes, note existance of attributes depends on usage in main feature. More...
 
void SetHoleCenters (const std::vector< NXOpen::Point * > &holes)
 Sets the hole centers of the die pad. More...
 
void SetHoleDiameter (double holeDiameter)
 Sets the hole diameter of the die pad. More...
 
void SetLength (double length)
 Sets the length of the die pad. More...
 
void SetLimitingSurface (NXOpen::IOrientation *limitingSurface)
 Sets the limiting surface of the die pad. More...
 
void SetLocation (NXOpen::ILocation *location)
 Sets the location of the die pad. More...
 
void SetLocationOffset (double locationOffset)
 Sets the location offset of the die pad. More...
 
void SetLocationOffsetDirection (NXOpen::IReferenceAxis *locationOffsetDirection)
 Sets the location offset direction of the die pad. More...
 
void SetOrientationPlane (NXOpen::IOrientation *orientationPlane)
 Sets the orientation plane of the die pad. More...
 
void SetPadAttributes (const NXString &title, const NXString &value, int color)
 Sets the pad attributes, note existance of attributes depends on usage in main feature. More...
 
void SetPadAttributes (const char *title, const char *value, int color)
 Sets the pad attributes, note existance of attributes depends on usage in main feature. More...
 
void SetRelief (bool relief)
 Sets the relief switch of the die pad, if true the relief will be built around the pad, if false it will not. More...
 
void SetReliefAttributes (const NXString &title, const NXString &value, int color)
 Sets the relief attributes, note existance of attributes depends on usage in main feature. More...
 
void SetReliefAttributes (const char *title, const char *value, int color)
 Sets the relief attributes, note existance of attributes depends on usage in main feature. More...
 
void SetReliefDepth (double reliefDepth)
 Sets the relief depth of the die pad. More...
 
void SetReliefWidth (double reliefWidth)
 Sets the relief width of the die pad. More...
 
void SetReverseOrientation (bool reverseOrientation)
 Sets the value to reverse the orientation of the orientation plane, if true the pad orientation normal will be reversed, if false it will not. More...
 
void SetShape (NXOpen::Die::DirectionOption direction, const std::vector< NXOpen::IProfile * > &profileEntries)
 Sets the shape profile of the die pad. More...
 
void SetShapeType (NXOpen::Die::PadChildBuilder::ShapeTypeOption shapeType)
 Sets the shape type of the die pad. More...
 
void SetSurfaceOffset (double surfaceOffset)
 Sets the surface offset of the die pad. More...
 
void SetWidth (double width)
 Sets the width of the die pad. More...
 
NXOpen::Die::PadChildBuilder::ShapeTypeOption ShapeType ()
 Returns the shape type of the die pad. More...
 
double SurfaceOffset ()
 Returns the surface offset of the die pad. More...
 
void TranslateLocation (const NXOpen::Vector3d &translateDist)
 Translates the location of the die pad by the specified amount. More...
 
double Width ()
 Returns the width of the die pad. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.0.0. 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

Represents a Die Pad Child sub feature.


This sub feature is created via the main feature builder.

Created in NX4.0.0.

Member Enumeration Documentation

Settings for the shape type of the die pad.

Enumerator
ShapeTypeOptionRectangular 

Rectangular pad.

ShapeTypeOptionCircular 

Circular pad.

ShapeTypeOptionCurve 

Curve defined pad.

Member Function Documentation

NXOpen::Die::DieBuildStatusOption NXOpen::Die::PadChildBuilder::BuildStatus ( )

Returns the build status of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

bool NXOpen::Die::PadChildBuilder::CenterHole ( )

Returns the center hole switch of the die pad, if true the center hole will be created in the pad, if false it will not.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

bool NXOpen::Die::PadChildBuilder::DesignStatus ( )

Returns the design status of the die pad, if true the pad will be built into the model, if false it will not.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::PadChildBuilder::Diameter ( )

Returns the diameter of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

bool NXOpen::Die::PadChildBuilder::DisplayStatus ( )

Returns the display status of the die pad, if true input data to the pad will be displayed, if false the input data will not be displayed.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

void NXOpen::Die::PadChildBuilder::GetHoleAttributes ( NXString title,
NXString value,
int *  color,
NXString diameterTitle 
)

Gets the hole attributes, note existance of attributes depends on usage in main feature.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
titleTitle for attribute.
valueValue of attribute.
colorColor of hole faces.
diameterTitleTitle for diameter attribute.
std::vector<NXOpen::Point *> NXOpen::Die::PadChildBuilder::GetHoleCenters ( )

Gets the hole centers of the die pad.

Returns
The hole centers.
Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")
void NXOpen::Die::PadChildBuilder::GetPadAttributes ( NXString title,
NXString value,
int *  color 
)

Gets the pad attributes, note existance of attributes depends on usage in main feature.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
titleTitle for attribute.
valueValue of attribute.
colorColor of pad faces.
void NXOpen::Die::PadChildBuilder::GetReliefAttributes ( NXString title,
NXString value,
int *  color 
)

Gets the relief attributes, note existance of attributes depends on usage in main feature.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
titleTitle for attribute.
valueValue of attribute.
colorColor of relief faces.
std::vector<NXOpen::IProfile *> NXOpen::Die::PadChildBuilder::GetShape ( NXOpen::Die::DirectionOption direction)

Gets the shape profile of the die pads.

Returns
The profile entries, will be curves, edges, faces, sketches or curve features.
Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")
Parameters
directionProfile direction.
double NXOpen::Die::PadChildBuilder::Height ( )

Returns the height of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::PadChildBuilder::HoleDiameter ( )

Returns the hole diameter of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::PadChildBuilder::Length ( )

Returns the length of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

NXOpen::IOrientation* NXOpen::Die::PadChildBuilder::LimitingSurface ( )

Returns the limiting surface of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

NXOpen::ILocation* NXOpen::Die::PadChildBuilder::Location ( )

Returns the location of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::PadChildBuilder::LocationOffset ( )

Returns the location offset of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

NXOpen::IReferenceAxis* NXOpen::Die::PadChildBuilder::LocationOffsetDirection ( )

Returns the location offset direction of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

NXOpen::IOrientation* NXOpen::Die::PadChildBuilder::OrientationPlane ( )

Returns the orientation plane of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

bool NXOpen::Die::PadChildBuilder::Relief ( )

Returns the relief switch of the die pad, if true the relief will be built around the pad, if false it will not.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::PadChildBuilder::ReliefDepth ( )

Returns the relief depth of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::PadChildBuilder::ReliefWidth ( )

Returns the relief width of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

bool NXOpen::Die::PadChildBuilder::ReverseOrientation ( )

Returns the value to reverse the orientation of the orientation plane, if true the pad orientation normal will be reversed, if false it will not.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

void NXOpen::Die::PadChildBuilder::SetCenterHole ( bool  centerHole)

Sets the center hole switch of the die pad, if true the center hole will be created in the pad, if false it will not.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
centerHolecenter hole
void NXOpen::Die::PadChildBuilder::SetDesignStatus ( bool  designStatus)

Sets the design status of the die pad, if true the pad will be built into the model, if false it will not.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
designStatusdesign status
void NXOpen::Die::PadChildBuilder::SetDiameter ( double  diameter)

Sets the diameter of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
diameterdiameter
void NXOpen::Die::PadChildBuilder::SetDisplayStatus ( bool  displayStatus)

Sets the display status of the die pad, if true input data to the pad will be displayed, if false the input data will not be displayed.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
displayStatusdisplay status
void NXOpen::Die::PadChildBuilder::SetHeight ( double  height)

Sets the height of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
heightheight
void NXOpen::Die::PadChildBuilder::SetHoleAttributes ( const NXString title,
const NXString value,
int  color,
const NXString diameterTitle 
)

Sets the hole attributes, note existance of attributes depends on usage in main feature.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
titleTitle for attribute.
valueValue of attribute.
colorColor of hole faces.
diameterTitleTitle for diameter attribute.
void NXOpen::Die::PadChildBuilder::SetHoleAttributes ( const char *  title,
const char *  value,
int  color,
const char *  diameterTitle 
)

Sets the hole attributes, note existance of attributes depends on usage in main feature.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
titleTitle for attribute.
valueValue of attribute.
colorColor of hole faces.
diameterTitleTitle for diameter attribute.
void NXOpen::Die::PadChildBuilder::SetHoleCenters ( const std::vector< NXOpen::Point * > &  holes)

Sets the hole centers of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
holesThe hole centers.
void NXOpen::Die::PadChildBuilder::SetHoleDiameter ( double  holeDiameter)

Sets the hole diameter of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
holeDiameterhole diameter
void NXOpen::Die::PadChildBuilder::SetLength ( double  length)

Sets the length of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
lengthlength
void NXOpen::Die::PadChildBuilder::SetLimitingSurface ( NXOpen::IOrientation limitingSurface)

Sets the limiting surface of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
limitingSurfacelimiting surface
void NXOpen::Die::PadChildBuilder::SetLocation ( NXOpen::ILocation location)

Sets the location of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
locationlocation
void NXOpen::Die::PadChildBuilder::SetLocationOffset ( double  locationOffset)

Sets the location offset of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
locationOffsetlocation offset
void NXOpen::Die::PadChildBuilder::SetLocationOffsetDirection ( NXOpen::IReferenceAxis locationOffsetDirection)

Sets the location offset direction of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
locationOffsetDirectionlocation offset direction
void NXOpen::Die::PadChildBuilder::SetOrientationPlane ( NXOpen::IOrientation orientationPlane)

Sets the orientation plane of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
orientationPlaneorientation plane
void NXOpen::Die::PadChildBuilder::SetPadAttributes ( const NXString title,
const NXString value,
int  color 
)

Sets the pad attributes, note existance of attributes depends on usage in main feature.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
titleTitle for attribute.
valueValue of attribute.
colorColor of pad faces.
void NXOpen::Die::PadChildBuilder::SetPadAttributes ( const char *  title,
const char *  value,
int  color 
)

Sets the pad attributes, note existance of attributes depends on usage in main feature.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
titleTitle for attribute.
valueValue of attribute.
colorColor of pad faces.
void NXOpen::Die::PadChildBuilder::SetRelief ( bool  relief)

Sets the relief switch of the die pad, if true the relief will be built around the pad, if false it will not.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
reliefrelief
void NXOpen::Die::PadChildBuilder::SetReliefAttributes ( const NXString title,
const NXString value,
int  color 
)

Sets the relief attributes, note existance of attributes depends on usage in main feature.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
titleTitle for attribute.
valueValue of attribute.
colorColor of relief faces.
void NXOpen::Die::PadChildBuilder::SetReliefAttributes ( const char *  title,
const char *  value,
int  color 
)

Sets the relief attributes, note existance of attributes depends on usage in main feature.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
titleTitle for attribute.
valueValue of attribute.
colorColor of relief faces.
void NXOpen::Die::PadChildBuilder::SetReliefDepth ( double  reliefDepth)

Sets the relief depth of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
reliefDepthrelief depth
void NXOpen::Die::PadChildBuilder::SetReliefWidth ( double  reliefWidth)

Sets the relief width of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
reliefWidthrelief width
void NXOpen::Die::PadChildBuilder::SetReverseOrientation ( bool  reverseOrientation)

Sets the value to reverse the orientation of the orientation plane, if true the pad orientation normal will be reversed, if false it will not.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
reverseOrientationreverse orientation
void NXOpen::Die::PadChildBuilder::SetShape ( NXOpen::Die::DirectionOption  direction,
const std::vector< NXOpen::IProfile * > &  profileEntries 
)

Sets the shape profile of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
directionProfile direction.
profileEntriesThe profile entries, can be curves, edges, faces, sketches or curve features.
void NXOpen::Die::PadChildBuilder::SetShapeType ( NXOpen::Die::PadChildBuilder::ShapeTypeOption  shapeType)

Sets the shape type of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
shapeTypeshape type
void NXOpen::Die::PadChildBuilder::SetSurfaceOffset ( double  surfaceOffset)

Sets the surface offset of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
surfaceOffsetsurface offset
void NXOpen::Die::PadChildBuilder::SetWidth ( double  width)

Sets the width of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
widthwidth
NXOpen::Die::PadChildBuilder::ShapeTypeOption NXOpen::Die::PadChildBuilder::ShapeType ( )

Returns the shape type of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::PadChildBuilder::SurfaceOffset ( )

Returns the surface offset of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

void NXOpen::Die::PadChildBuilder::TranslateLocation ( const NXOpen::Vector3d translateDist)

Translates the location of the die pad by the specified amount.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
translateDistA scaled vector indicating the distance to translate
double NXOpen::Die::PadChildBuilder::Width ( )

Returns the width of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")


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