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

Represents a Die Keyway Parent sub feature. More...

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

List of all members.

Public Types

enum  RunoffTypeOption { RunoffTypeOptionRectangular, RunoffTypeOptionCircular }
 Settings for the runoff type of the keyway. More...

Public Member Functions

NXOpen::Die::DieBuildStatusOption BuildStatus ()
 Returns the build status of keyways.
NXOpen::Die::KeywayChildBuilderCreateChild ()
 Creates a child keyway.
void DeleteChild (NXOpen::Die::KeywayChildBuilder *diekeywaychild)
 Deletes a child keyway.
double Depth ()
 Returns the depth of keyways.
bool DesignStatus ()
 Returns the design status of keyways, if true the keyways will be built into the model, if false they will not.
bool DisplayStatus ()
 Returns the display status of keyways, if true input data to the keyways will be displayed, if false the input data will not be displayed.
std::vector
< NXOpen::Die::KeywayChildBuilder * > 
GetChildren ()
 Outputs the child keyways.
void GetPadAttributes (NXString *title, NXString *value, int *color)
 Gets the pad attributes, note existance of attributes depends on usage in main feature.
void GetSlotAttributes (NXString *title, NXString *value, int *color)
 Gets the slot attributes, note existance of attributes depends on usage in main feature.
double Length ()
 Returns the length of keyways.
double MinimumRibHeight ()
 Returns the minimum rib height of keyways.
double PadHeight ()
 Returns the pad height of keyways.
double PadWidth ()
 Returns the pad width of keyways.
double PlacementOffset ()
 Returns the placement offset of keyways.
double RunoffDepth ()
 Returns the runoff depth of keyways.
double RunoffDiameter ()
 Returns the runoff diameter of keyways.
double RunoffLength ()
 Returns the runoff length of keyways.
NXOpen::Die::KeywayParentBuilder::RunoffTypeOption RunoffType ()
 Returns the runoff type of keyways.
double RunoffWidth ()
 Returns the runoff width of keyways.
void SetDepth (double depth)
 Sets the depth of keyways.
void SetDesignStatus (bool designStatus)
 Sets the design status of keyways, if true the keyways will be built into the model, if false they will not.
void SetDisplayStatus (bool displayStatus)
 Sets the display status of keyways, if true input data to the keyways will be displayed, if false the input data will not be displayed.
void SetLength (double length)
 Sets the length of keyways.
void SetMinimumRibHeight (double minimumRibHeight)
 Sets the minimum rib height of keyways.
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 SetPadHeight (double padHeight)
 Sets the pad height of keyways.
void SetPadWidth (double padWidth)
 Sets the pad width of keyways.
void SetPlacementOffset (double placementOffset)
 Sets the placement offset of keyways.
void SetRunoffDepth (double runoffDepth)
 Sets the runoff depth of keyways.
void SetRunoffDiameter (double runoffDiameter)
 Sets the runoff diameter of keyways.
void SetRunoffLength (double runoffLength)
 Sets the runoff length of keyways.
void SetRunoffType (NXOpen::Die::KeywayParentBuilder::RunoffTypeOption runoffType)
 Sets the runoff type of keyways.
void SetRunoffWidth (double runoffWidth)
 Sets the runoff width of keyways.
void SetSlotAttributes (const NXString &title, const NXString &value, int color)
 Sets the slot attributes, note existance of attributes depends on usage in main feature.
void SetWidth (double width)
 Sets the width of keyways.
double Width ()
 Returns the width of keyways.

Detailed Description

Represents a Die Keyway Parent sub feature.


This sub feature is created via the main feature builder.

Created in NX4.0.0.


Member Enumeration Documentation

Settings for the runoff type of the keyway.

Enumerator:
RunoffTypeOptionRectangular 

Rectangular runoff.

RunoffTypeOptionCircular 

Circular runoff.


Member Function Documentation

Returns the build status of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Creates a child keyway.

Returns:

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Deletes a child keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
diekeywaychilddiekeywaychild

Returns the depth of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the design status of keyways, if true the keyways will be built into the model, if false they will not.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

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


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Outputs the child keyways.

Returns:
The child keyways.
Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")
void NXOpen::Die::KeywayParentBuilder::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::KeywayParentBuilder::GetSlotAttributes ( NXString title,
NXString value,
int *  color 
)

Gets the slot 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 slot faces.

Returns the length of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the minimum rib height of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the pad height of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the pad width of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the placement offset of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the runoff depth of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the runoff diameter of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the runoff length of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the runoff type of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the runoff width of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Sets the depth of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
depthdepth

Sets the design status of keyways, if true the keyways will be built into the model, if false they will not.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
designStatusdesign status

Sets the display status of keyways, if true input data to the keyways 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

Sets the length of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
lengthlength
void NXOpen::Die::KeywayParentBuilder::SetMinimumRibHeight ( double  minimumRibHeight)

Sets the minimum rib height of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
minimumRibHeightminimum rib height
void NXOpen::Die::KeywayParentBuilder::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 pad height of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
padHeightpad height

Sets the pad width of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
padWidthpad width
void NXOpen::Die::KeywayParentBuilder::SetPlacementOffset ( double  placementOffset)

Sets the placement offset of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
placementOffsetplacement offset

Sets the runoff depth of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
runoffDepthrunoff depth
void NXOpen::Die::KeywayParentBuilder::SetRunoffDiameter ( double  runoffDiameter)

Sets the runoff diameter of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
runoffDiameterrunoff diameter

Sets the runoff length of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
runoffLengthrunoff length

Sets the runoff type of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
runoffTyperunoff type

Sets the runoff width of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
runoffWidthrunoff width
void NXOpen::Die::KeywayParentBuilder::SetSlotAttributes ( const NXString title,
const NXString value,
int  color 
)

Sets the slot 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 slot faces.

Sets the width of keyways.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
widthwidth

Returns the width of keyways.


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.