NX Open C++ Reference Guide
Public Types | Public Member Functions
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

List of all members.

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.
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.
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.
double Diameter ()
 Returns the diameter of the die pad.
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.
void GetHoleAttributes (NXString *title, NXString *value, int *color, NXString *diameterTitle)
 Gets the hole attributes, note existance of attributes depends on usage in main feature.
std::vector< NXOpen::Point * > GetHoleCenters ()
 Gets the hole centers of the die pad.
void GetPadAttributes (NXString *title, NXString *value, int *color)
 Gets the pad attributes, note existance of attributes depends on usage in main feature.
void GetReliefAttributes (NXString *title, NXString *value, int *color)
 Gets the relief attributes, note existance of attributes depends on usage in main feature.
std::vector< NXOpen::IProfile * > GetShape (NXOpen::Die::DirectionOption *direction)
 Gets the shape profile of the die pads.
double Height ()
 Returns the height of the die pad.
double HoleDiameter ()
 Returns the hole diameter of the die pad.
double Length ()
 Returns the length of the die pad.
NXOpen::IOrientationLimitingSurface ()
 Returns the limiting surface of the die pad.
NXOpen::ILocationLocation ()
 Returns the location of the die pad.
double LocationOffset ()
 Returns the location offset of the die pad.
NXOpen::IReferenceAxisLocationOffsetDirection ()
 Returns the location offset direction of the die pad.
NXOpen::IOrientationOrientationPlane ()
 Returns the orientation plane of the die pad.
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.
double ReliefDepth ()
 Returns the relief depth of the die pad.
double ReliefWidth ()
 Returns the relief width of the die pad.
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.
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.
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.
void SetDiameter (double diameter)
 Sets the diameter of the die pad.
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.
void SetHeight (double height)
 Sets the height of the die pad.
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.
void SetHoleCenters (const std::vector< NXOpen::Point * > &holes)
 Sets the hole centers of the die pad.
void SetHoleDiameter (double holeDiameter)
 Sets the hole diameter of the die pad.
void SetLength (double length)
 Sets the length of the die pad.
void SetLimitingSurface (NXOpen::IOrientation *limitingSurface)
 Sets the limiting surface of the die pad.
void SetLocation (NXOpen::ILocation *location)
 Sets the location of the die pad.
void SetLocationOffset (double locationOffset)
 Sets the location offset of the die pad.
void SetLocationOffsetDirection (NXOpen::IReferenceAxis *locationOffsetDirection)
 Sets the location offset direction of the die pad.
void SetOrientationPlane (NXOpen::IOrientation *orientationPlane)
 Sets the orientation plane of the die pad.
void SetPadAttributes (const NXString &title, const NXString &value, int color)
 Sets the pad attributes, note existance of attributes depends on usage in main feature.
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.
void SetReliefAttributes (const NXString &title, const NXString &value, int color)
 Sets the relief attributes, note existance of attributes depends on usage in main feature.
void SetReliefDepth (double reliefDepth)
 Sets the relief depth of the die pad.
void SetReliefWidth (double reliefWidth)
 Sets the relief width of the die pad.
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.
void SetShape (NXOpen::Die::DirectionOption direction, const std::vector< NXOpen::IProfile * > &profileEntries)
 Sets the shape profile of the die pad.
void SetShapeType (NXOpen::Die::PadChildBuilder::ShapeTypeOption shapeType)
 Sets the shape type of the die pad.
void SetSurfaceOffset (double surfaceOffset)
 Sets the surface offset of the die pad.
void SetWidth (double width)
 Sets the width of the die pad.
NXOpen::Die::PadChildBuilder::ShapeTypeOption ShapeType ()
 Returns the shape type of the die pad.
double SurfaceOffset ()
 Returns the surface offset of the die pad.
void TranslateLocation (const NXOpen::Vector3d &translateDist)
 Translates the location of the die pad by the specified amount.
double Width ()
 Returns the width of the die pad.

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

Returns the build status of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

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")

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")

Returns the diameter of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

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.

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.

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.

Returns the height of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the hole diameter of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the length of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the limiting surface of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the location of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the location offset of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the location offset direction of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the orientation plane of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

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")

Returns the relief depth of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the relief width of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

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")

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.
NOTE: The full Unicode character set is not supported for this parameter.
valueValue of attribute.
NOTE: The full Unicode character set is not supported for this parameter.
colorColor of hole faces.
diameterTitleTitle for diameter attribute.
NOTE: The full Unicode character set is not supported for this parameter.
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

Sets the limiting surface of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
limitingSurfacelimiting surface

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

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

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.
NOTE: The full Unicode character set is not supported for this parameter.
valueValue of attribute.
NOTE: The full Unicode character set is not supported for this parameter.
colorColor of pad faces.

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.
NOTE: The full Unicode character set is not supported for this parameter.
valueValue of attribute.
NOTE: The full Unicode character set is not supported for this parameter.
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.

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

Sets the width of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
widthwidth

Returns the shape type of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the surface offset of the die pad.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

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

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 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.