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

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

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

Public Types

enum  TypeOption { TypeOptionWipe, TypeOptionRestrike }
 Settings for the type of the throat section. More...
 

Public Member Functions

NXOpen::Die::DieBuildStatusOption BuildStatus ()
 Returns the build status of the throat section. More...
 
NXOpen::ExpressionCavityDepth ()
 Returns the distance measured from the bend profile of the flange to the base of the throat. More...
 
NXOpen::ExpressionCavityOffset ()
 Returns the offset distance measured from the Throat CSYS to the back cavity area of the throat. More...
 
bool DesignStatus ()
 Returns the design status of the throat section, if true the throat section will be built into the model, if false it will not. More...
 
bool DisplayStatus ()
 Returns the display status of the throat section, if true input data to the throat section will be displayed, if false the input data will not be displayed. More...
 
NXOpen::ExpressionExtensionLength ()
 Returns the tangent distance to add to the end of the flange. More...
 
void GetCavityAttributes (NXString *title, NXString *value, int *color)
 Gets the cavity attributes, note existance of attributes depends on usage in main feature. More...
 
void GetExtensionAttributes (NXString *title, NXString *value, int *color)
 Gets the extension attributes, note existance of attributes depends on usage in main feature. More...
 
NXOpen::ExpressionLowerRadius ()
 Returns the radius to apply to the lower corner of the throat cavity. More...
 
double Radius ()
 Returns the radius to be applied at the back of the throat, top and bottom
Created in NX4.0.0. More...
 
NXOpen::ExpressionSectionPlacement ()
 Returns the throat section placement along the center line, an expression containg the length along the centerline for placement
Created in NX4.0.0. More...
 
void SetCavityAttributes (const NXString &title, const NXString &value, int color)
 Sets the cavity attributes, note existance of attributes depends on usage in main feature. More...
 
void SetCavityAttributes (const char *title, const char *value, int color)
 Sets the cavity attributes, note existance of attributes depends on usage in main feature. More...
 
void SetCavityDepth (const NXString &cavityDepth)
 
Created in NX4.0.0. More...
 
void SetCavityDepth (const char *cavityDepth)
 
Created in NX4.0.0. More...
 
void SetCavityOffset (const NXString &cavityOffset)
 
Created in NX4.0.0. More...
 
void SetCavityOffset (const char *cavityOffset)
 
Created in NX4.0.0. More...
 
void SetDesignStatus (bool designStatus)
 Sets the design status of the throat section, if true the throat section will be built into the model, if false it will not. More...
 
void SetDisplayStatus (bool displayStatus)
 Sets the display status of the throat section, if true input data to the throat section will be displayed, if false the input data will not be displayed. More...
 
void SetExtensionAttributes (const NXString &title, const NXString &value, int color)
 Sets the extension attributes, note existance of attributes depends on usage in main feature. More...
 
void SetExtensionAttributes (const char *title, const char *value, int color)
 Sets the extension attributes, note existance of attributes depends on usage in main feature. More...
 
void SetExtensionLength (const NXString &extensionLength)
 
Created in NX4.0.0. More...
 
void SetExtensionLength (const char *extensionLength)
 
Created in NX4.0.0. More...
 
void SetLowerRadius (const NXString &lowerRadius)
 
Created in NX4.0.0. More...
 
void SetLowerRadius (const char *lowerRadius)
 
Created in NX4.0.0. More...
 
void SetRadius (double radius)
 Sets the radius to be applied at the back of the throat, top and bottom
Created in NX4.0.0. More...
 
void SetSectionPlacement (const NXString &sectionPlacement)
 
Created in NX4.0.0. More...
 
void SetSectionPlacement (const char *sectionPlacement)
 
Created in NX4.0.0. More...
 
void SetStep (double step)
 Sets the step to be applied at the end of the tangent extension of the flange
Created in NX4.0.0. More...
 
void SetStepDistance (const NXString &stepDistance)
 
Created in NX4.0.0. More...
 
void SetStepDistance (const char *stepDistance)
 
Created in NX4.0.0. More...
 
void SetUpperRadius (const NXString &upperRadius)
 
Created in NX4.0.0. More...
 
void SetUpperRadius (const char *upperRadius)
 
Created in NX4.0.0. More...
 
double Step ()
 Returns the step to be applied at the end of the tangent extension of the flange
Created in NX4.0.0. More...
 
NXOpen::ExpressionStepDistance ()
 Returns the step distance to add at the end of the tangent extension. More...
 
NXOpen::ExpressionUpperRadius ()
 Returns the radius to apply to the upper corner of the throat cavity. 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 Throat Child sub feature.


This sub feature is created via the main feature builder.

Created in NX4.0.0.

Member Enumeration Documentation

Settings for the type of the throat section.

Enumerator
TypeOptionWipe 

Throat section is built for a wipe operation.

TypeOptionRestrike 

Throat section is built for a restrike operation.

Member Function Documentation

NXOpen::Die::DieBuildStatusOption NXOpen::Die::ThroatChildBuilder::BuildStatus ( )

Returns the build status of the throat section.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

NXOpen::Expression* NXOpen::Die::ThroatChildBuilder::CavityDepth ( )

Returns the distance measured from the bend profile of the flange to the base of the throat.

The base of the throat is considered to be the surface the wear plates are mounted on for guiding and aliging the flange steels. The value given must be larger than the minimum cavity depth. An expression containg the value. Value is used in both the Wipe and Restrike Flange.
Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

NXOpen::Expression* NXOpen::Die::ThroatChildBuilder::CavityOffset ( )

Returns the offset distance measured from the Throat CSYS to the back cavity area of the throat.

Both positive and negative values may given to adjust the cavity to the proper location. An expression containg the value. Value is used in both the Wipe and Restrike Flange.
Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

bool NXOpen::Die::ThroatChildBuilder::DesignStatus ( )

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


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

bool NXOpen::Die::ThroatChildBuilder::DisplayStatus ( )

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


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

NXOpen::Expression* NXOpen::Die::ThroatChildBuilder::ExtensionLength ( )

Returns the tangent distance to add to the end of the flange.

An expression containg the length along the tangent. Value is used in both the Wipe and Restrike Flange.
Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

void NXOpen::Die::ThroatChildBuilder::GetCavityAttributes ( NXString title,
NXString value,
int *  color 
)

Gets the cavity 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 cavity faces.
void NXOpen::Die::ThroatChildBuilder::GetExtensionAttributes ( NXString title,
NXString value,
int *  color 
)

Gets the extension 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 extension faces.
NXOpen::Expression* NXOpen::Die::ThroatChildBuilder::LowerRadius ( )

Returns the radius to apply to the lower corner of the throat cavity.

Typically, both the lower and the upper radius will be the same. An expression containg the value. Value is used in both the Wipe and Restrike Flange.
Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::ThroatChildBuilder::Radius ( )

Returns the radius to be applied at the back of the throat, top and bottom
Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

NXOpen::Expression* NXOpen::Die::ThroatChildBuilder::SectionPlacement ( )

Returns the throat section placement along the center line, an expression containg the length along the centerline for placement
Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

void NXOpen::Die::ThroatChildBuilder::SetCavityAttributes ( const NXString title,
const NXString value,
int  color 
)

Sets the cavity 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 cavity faces.
void NXOpen::Die::ThroatChildBuilder::SetCavityAttributes ( const char *  title,
const char *  value,
int  color 
)

Sets the cavity 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 cavity faces.
void NXOpen::Die::ThroatChildBuilder::SetCavityDepth ( const NXString cavityDepth)


Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
cavityDepthcavity depth
void NXOpen::Die::ThroatChildBuilder::SetCavityDepth ( const char *  cavityDepth)


Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
cavityDepthcavity depth
void NXOpen::Die::ThroatChildBuilder::SetCavityOffset ( const NXString cavityOffset)


Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
cavityOffsetcavity offset
void NXOpen::Die::ThroatChildBuilder::SetCavityOffset ( const char *  cavityOffset)


Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
cavityOffsetcavity offset
void NXOpen::Die::ThroatChildBuilder::SetDesignStatus ( bool  designStatus)

Sets the design status of the throat section, if true the throat section 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::ThroatChildBuilder::SetDisplayStatus ( bool  displayStatus)

Sets the display status of the throat section, if true input data to the throat section 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::ThroatChildBuilder::SetExtensionAttributes ( const NXString title,
const NXString value,
int  color 
)

Sets the extension 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 extension faces.
void NXOpen::Die::ThroatChildBuilder::SetExtensionAttributes ( const char *  title,
const char *  value,
int  color 
)

Sets the extension 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 extension faces.
void NXOpen::Die::ThroatChildBuilder::SetExtensionLength ( const NXString extensionLength)


Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
extensionLengthextension length
void NXOpen::Die::ThroatChildBuilder::SetExtensionLength ( const char *  extensionLength)


Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
extensionLengthextension length
void NXOpen::Die::ThroatChildBuilder::SetLowerRadius ( const NXString lowerRadius)


Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
lowerRadiuslower radius
void NXOpen::Die::ThroatChildBuilder::SetLowerRadius ( const char *  lowerRadius)


Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
lowerRadiuslower radius
void NXOpen::Die::ThroatChildBuilder::SetRadius ( double  radius)

Sets the radius to be applied at the back of the throat, top and bottom
Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
radiusradius
void NXOpen::Die::ThroatChildBuilder::SetSectionPlacement ( const NXString sectionPlacement)


Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
sectionPlacementsection placement
void NXOpen::Die::ThroatChildBuilder::SetSectionPlacement ( const char *  sectionPlacement)


Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
sectionPlacementsection placement
void NXOpen::Die::ThroatChildBuilder::SetStep ( double  step)

Sets the step to be applied at the end of the tangent extension of the flange
Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
stepstep
void NXOpen::Die::ThroatChildBuilder::SetStepDistance ( const NXString stepDistance)


Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
stepDistancestep distance
void NXOpen::Die::ThroatChildBuilder::SetStepDistance ( const char *  stepDistance)


Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
stepDistancestep distance
void NXOpen::Die::ThroatChildBuilder::SetUpperRadius ( const NXString upperRadius)


Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
upperRadiusupper radius
void NXOpen::Die::ThroatChildBuilder::SetUpperRadius ( const char *  upperRadius)


Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
upperRadiusupper radius
double NXOpen::Die::ThroatChildBuilder::Step ( )

Returns the step to be applied at the end of the tangent extension of the flange
Created in NX4.0.0.



License requirements : ug_die_design ("Die Design")

NXOpen::Expression* NXOpen::Die::ThroatChildBuilder::StepDistance ( )

Returns the step distance to add at the end of the tangent extension.

The step is at a right angle and only applies to the Wipe Flange. An expression containg the step distance.
Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

NXOpen::Expression* NXOpen::Die::ThroatChildBuilder::UpperRadius ( )

Returns the radius to apply to the upper corner of the throat cavity.

An expression containg the value. Value is used in both the Wipe and Restrike Flange.
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.