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

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

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

Public Member Functions

NXOpen::Die::DieBuildStatusOption BuildStatus ()
 Returns the build status of the die hole. More...
 
NXOpen::ILocationCenter ()
 Returns the center of the die hole. More...
 
double CounterBoreDiameter ()
 Returns the counter bore diameter of the die hole. More...
 
bool CreateWithPad ()
 Returns the create with pad switch of the die hole, if true a pad will be created around the hole, if false the pad will not be created. More...
 
double Depth ()
 Returns the depth of the die hole. More...
 
bool DesignStatus ()
 Returns the design status of the die hole, if true the hole will be built into the model, if false it will not. More...
 
double Diameter ()
 Returns the diameter of the die hole. More...
 
bool DisplayHoles ()
 Returns the display holes switch of the die hole, if true the hole will be built into the model, if false it will not. More...
 
bool DisplayStatus ()
 Returns the display status of the die hole, if true input data to the hole will be displayed, if false the input data will not be displayed. More...
 
double DropThruDiameter ()
 Returns the drop thru diameter of the die hole. More...
 
void GetHoleAttributes (NXString *title, NXString *value, int *color, NXString *diameterTitle, NXString *depthTitle, NXString *counterBoreDiameterTitle)
 Gets the hole attributes, note existance of attributes depends on usage in main feature. More...
 
void GetPadAttributes (NXString *title, NXString *value, int *color)
 Gets the pad attributes, note existance of attributes depends on usage in main feature. More...
 
double PadDiameter ()
 Returns the pad diameter of the die hole. More...
 
double PadHeight ()
 Returns the pad height of the die hole. More...
 
NXOpen::ISurfacePlane ()
 Returns the plane of the die hole. More...
 
double PlaneOffset ()
 Returns the plane offset of the die hole. More...
 
void SetCenter (NXOpen::ILocation *center)
 Sets the center of the die hole. More...
 
void SetCounterBoreDiameter (double counterBoreDiameter)
 Sets the counter bore diameter of the die hole. More...
 
void SetCreateWithPad (bool createWithPad)
 Sets the create with pad switch of the die hole, if true a pad will be created around the hole, if false the pad will not be created. More...
 
void SetDepth (double depth)
 Sets the depth of the die hole. More...
 
void SetDesignStatus (bool designStatus)
 Sets the design status of the die hole, if true the hole will be built into the model, if false it will not. More...
 
void SetDiameter (double diameter)
 Sets the diameter of the die hole. More...
 
void SetDisplayHoles (bool displayHoles)
 Sets the display holes switch of the die hole, if true the hole will be built into the model, if false it will not. More...
 
void SetDisplayStatus (bool displayStatus)
 Sets the display status of the die hole, if true input data to the hole will be displayed, if false the input data will not be displayed. More...
 
void SetDropThruDiameter (double dropThruDiameter)
 Sets the drop thru diameter of the die hole. More...
 
void SetHoleAttributes (const NXString &title, const NXString &value, int color, const NXString &diameterTitle, const NXString &depthTitle, const NXString &counterBoreDiameterTitle)
 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, const char *depthTitle, const char *counterBoreDiameterTitle)
 Sets the hole attributes, note existance of attributes depends on usage in main feature. 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 SetPadDiameter (double padDiameter)
 Sets the pad diameter of the die hole. More...
 
void SetPadHeight (double padHeight)
 Sets the pad height of the die hole. More...
 
void SetPlane (NXOpen::ISurface *plane)
 Sets the plane of the die hole. More...
 
void SetPlaneOffset (double planeOffset)
 Sets the plane offset of the die hole. More...
 
void TranslateCenter (const NXOpen::Vector3d &translateDist)
 Translates the center of the die hole by the specified amount. 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 Hole Child sub feature.


This sub feature is created via the main feature builder.

Created in NX4.0.0.

Member Function Documentation

NXOpen::Die::DieBuildStatusOption NXOpen::Die::HoleChildBuilder::BuildStatus ( )

Returns the build status of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

NXOpen::ILocation* NXOpen::Die::HoleChildBuilder::Center ( )

Returns the center of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::HoleChildBuilder::CounterBoreDiameter ( )

Returns the counter bore diameter of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

bool NXOpen::Die::HoleChildBuilder::CreateWithPad ( )

Returns the create with pad switch of the die hole, if true a pad will be created around the hole, if false the pad will not be created.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::HoleChildBuilder::Depth ( )

Returns the depth of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

bool NXOpen::Die::HoleChildBuilder::DesignStatus ( )

Returns the design status of the die hole, if true the hole 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::HoleChildBuilder::Diameter ( )

Returns the diameter of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

bool NXOpen::Die::HoleChildBuilder::DisplayHoles ( )

Returns the display holes switch of the die hole, if true the hole will be built into the model, if false it will not.

Note that this setting has the same affect as design status, unless the create with pad switch is true.
Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

bool NXOpen::Die::HoleChildBuilder::DisplayStatus ( )

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


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::HoleChildBuilder::DropThruDiameter ( )

Returns the drop thru diameter of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

void NXOpen::Die::HoleChildBuilder::GetHoleAttributes ( NXString title,
NXString value,
int *  color,
NXString diameterTitle,
NXString depthTitle,
NXString counterBoreDiameterTitle 
)

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.
depthTitleTitle for depth attribute.
counterBoreDiameterTitleTitle for counter bore diameter attribute.
void NXOpen::Die::HoleChildBuilder::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.
double NXOpen::Die::HoleChildBuilder::PadDiameter ( )

Returns the pad diameter of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::HoleChildBuilder::PadHeight ( )

Returns the pad height of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

NXOpen::ISurface* NXOpen::Die::HoleChildBuilder::Plane ( )

Returns the plane of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::HoleChildBuilder::PlaneOffset ( )

Returns the plane offset of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

void NXOpen::Die::HoleChildBuilder::SetCenter ( NXOpen::ILocation center)

Sets the center of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
centercenter
void NXOpen::Die::HoleChildBuilder::SetCounterBoreDiameter ( double  counterBoreDiameter)

Sets the counter bore diameter of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
counterBoreDiametercounter bore diameter
void NXOpen::Die::HoleChildBuilder::SetCreateWithPad ( bool  createWithPad)

Sets the create with pad switch of the die hole, if true a pad will be created around the hole, if false the pad will not be created.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
createWithPadcreate with pad
void NXOpen::Die::HoleChildBuilder::SetDepth ( double  depth)

Sets the depth of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
depthdepth
void NXOpen::Die::HoleChildBuilder::SetDesignStatus ( bool  designStatus)

Sets the design status of the die hole, if true the hole 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::HoleChildBuilder::SetDiameter ( double  diameter)

Sets the diameter of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
diameterdiameter
void NXOpen::Die::HoleChildBuilder::SetDisplayHoles ( bool  displayHoles)

Sets the display holes switch of the die hole, if true the hole will be built into the model, if false it will not.

Note that this setting has the same affect as design status, unless the create with pad switch is true.
Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
displayHolesdisplay holes
void NXOpen::Die::HoleChildBuilder::SetDisplayStatus ( bool  displayStatus)

Sets the display status of the die hole, if true input data to the hole 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::HoleChildBuilder::SetDropThruDiameter ( double  dropThruDiameter)

Sets the drop thru diameter of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
dropThruDiameterdrop thru diameter
void NXOpen::Die::HoleChildBuilder::SetHoleAttributes ( const NXString title,
const NXString value,
int  color,
const NXString diameterTitle,
const NXString depthTitle,
const NXString counterBoreDiameterTitle 
)

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.
depthTitleTitle for depth attribute.
counterBoreDiameterTitleTitle for counter bore diameter attribute.
void NXOpen::Die::HoleChildBuilder::SetHoleAttributes ( const char *  title,
const char *  value,
int  color,
const char *  diameterTitle,
const char *  depthTitle,
const char *  counterBoreDiameterTitle 
)

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.
depthTitleTitle for depth attribute.
counterBoreDiameterTitleTitle for counter bore diameter attribute.
void NXOpen::Die::HoleChildBuilder::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::HoleChildBuilder::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::HoleChildBuilder::SetPadDiameter ( double  padDiameter)

Sets the pad diameter of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
padDiameterpad diameter
void NXOpen::Die::HoleChildBuilder::SetPadHeight ( double  padHeight)

Sets the pad height of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
padHeightpad height
void NXOpen::Die::HoleChildBuilder::SetPlane ( NXOpen::ISurface plane)

Sets the plane of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
planeplane
void NXOpen::Die::HoleChildBuilder::SetPlaneOffset ( double  planeOffset)

Sets the plane offset of the die hole.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters
planeOffsetplane offset
void NXOpen::Die::HoleChildBuilder::TranslateCenter ( const NXOpen::Vector3d translateDist)

Translates the center of the die hole 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

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