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

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

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

List of all members.

Public Types

enum  LocationOption { LocationOptionPositiveX, LocationOptionNegativeX, LocationOptionPositiveY, LocationOptionNegativeY }
 Settings for the location of the keyway. More...
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 the keyway.
double Depth ()
 Returns the depth of the keyway.
bool DesignStatus ()
 Returns the design status of the keyway, if true the keyway will be built into the model, if false it will not.
bool DisplayStatus ()
 Returns the display status of the keyway, if true input data to the keyway will be displayed, if false the input data will not be displayed.
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 the keyway.
NXOpen::Die::KeywayChildBuilder::LocationOption Location ()
 Returns the location of the keyway.
double MinimumRibHeight ()
 Returns the minimum rib height of the keyway.
double Offset ()
 Returns the offset of the keyway.
double PadHeight ()
 Returns the pad height of the keyway.
double PadWidth ()
 Returns the pad width of the keyway.
double PlacementOffset ()
 Returns the placement offset of the keyway.
NXOpen::IOrientationPlane ()
 Returns the plane of the keyway.
bool ReverseOrientation ()
 Returns the value to reverse the orientation of the orientation plane, if true the keyway orientation normal will be reversed, if false it will not.
double RunoffDepth ()
 Returns the runoff depth of the keyway.
double RunoffDiameter ()
 Returns the runoff diameter of the keyway.
double RunoffLength ()
 Returns the runoff length of the keyway.
NXOpen::Die::KeywayChildBuilder::RunoffTypeOption RunoffType ()
 Returns the runoff type of the keyway.
double RunoffWidth ()
 Returns the runoff width of the keyway.
void SetDepth (double depth)
 Sets the depth of the keyway.
void SetDesignStatus (bool designStatus)
 Sets the design status of the keyway, if true the keyway will be built into the model, if false it will not.
void SetDisplayStatus (bool displayStatus)
 Sets the display status of the keyway, if true input data to the keyway will be displayed, if false the input data will not be displayed.
void SetLength (double length)
 Sets the length of the keyway.
void SetLocation (NXOpen::Die::KeywayChildBuilder::LocationOption location)
 Sets the location of the keyway.
void SetMinimumRibHeight (double minimumRibHeight)
 Sets the minimum rib height of the keyway.
void SetOffset (double offset)
 Sets the offset of the keyway.
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 the keyway.
void SetPadWidth (double padWidth)
 Sets the pad width of the keyway.
void SetPlacementOffset (double placementOffset)
 Sets the placement offset of the keyway.
void SetPlane (NXOpen::IOrientation *plane)
 Sets the plane of the keyway.
void SetReverseOrientation (bool reverseOrientation)
 Sets the value to reverse the orientation of the orientation plane, if true the keyway orientation normal will be reversed, if false it will not.
void SetRunoffDepth (double runoffDepth)
 Sets the runoff depth of the keyway.
void SetRunoffDiameter (double runoffDiameter)
 Sets the runoff diameter of the keyway.
void SetRunoffLength (double runoffLength)
 Sets the runoff length of the keyway.
void SetRunoffType (NXOpen::Die::KeywayChildBuilder::RunoffTypeOption runoffType)
 Sets the runoff type of the keyway.
void SetRunoffWidth (double runoffWidth)
 Sets the runoff width of the keyway.
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 the keyway.
double Width ()
 Returns the width of the keyway.

Detailed Description

Represents a Die Keyway Child sub feature.


This sub feature is created via the main feature builder.

Created in NX4.0.0.


Member Enumeration Documentation

Settings for the location of the keyway.

Enumerator:
LocationOptionPositiveX 

Keyway built in positive x direction.

LocationOptionNegativeX 

Keyway built in negative x direction.

LocationOptionPositiveY 

Keyway built in positive y direction.

LocationOptionNegativeY 

Keyway built in negative y direction.

Settings for the runoff type of the keyway.

Enumerator:
RunoffTypeOptionRectangular 

Rectangular runoff.

RunoffTypeOptionCircular 

Circular runoff.


Member Function Documentation

Returns the build status of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the depth of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the design status of the keyway, if true the keyway 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 display status of the keyway, if true input data to the keyway 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::KeywayChildBuilder::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::KeywayChildBuilder::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 the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the location of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the minimum rib height of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the offset of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the pad height of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the pad width of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the placement offset of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the plane of the keyway.


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 keyway orientation normal will be reversed, if false it will not.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the runoff depth of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the runoff diameter of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the runoff length of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the runoff type of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Returns the runoff width of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Sets the depth of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
depthdepth

Sets the design status of the keyway, if true the keyway 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

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


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
lengthlength

Sets the location of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
locationlocation
void NXOpen::Die::KeywayChildBuilder::SetMinimumRibHeight ( double  minimumRibHeight)

Sets the minimum rib height of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
minimumRibHeightminimum rib height

Sets the offset of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
offsetoffset
void NXOpen::Die::KeywayChildBuilder::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 the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
padHeightpad height

Sets the pad width of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

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

Sets the placement offset of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
placementOffsetplacement offset

Sets the plane of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
planeplane
void NXOpen::Die::KeywayChildBuilder::SetReverseOrientation ( bool  reverseOrientation)

Sets the value to reverse the orientation of the orientation plane, if true the keyway 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

Sets the runoff depth of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

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

Sets the runoff diameter of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
runoffDiameterrunoff diameter
void NXOpen::Die::KeywayChildBuilder::SetRunoffLength ( double  runoffLength)

Sets the runoff length of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
runoffLengthrunoff length

Sets the runoff type of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
runoffTyperunoff type

Sets the runoff width of the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
runoffWidthrunoff width
void NXOpen::Die::KeywayChildBuilder::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 the keyway.


Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
widthwidth

Returns the width of the keyway.


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.