NXOpen::Die::KeywayChildBuilder Class Reference

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

Inheritance diagram for NXOpen::Die::KeywayChildBuilder:

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. More...
double	Depth ()
	Returns the depth of the keyway. More...
bool	DesignStatus ()
	Returns the design status of the keyway, if true the keyway will be built into the model, if false it will not. More...
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. More...
void	GetPadAttributes (NXString *title, NXString *value, int *color)
	Gets the pad attributes, note existance of attributes depends on usage in main feature. More...
void	GetSlotAttributes (NXString *title, NXString *value, int *color)
	Gets the slot attributes, note existance of attributes depends on usage in main feature. More...
double	Length ()
	Returns the length of the keyway. More...
NXOpen::Die::KeywayChildBuilder::LocationOption	Location ()
	Returns the location of the keyway. More...
double	MinimumRibHeight ()
	Returns the minimum rib height of the keyway. More...
double	Offset ()
	Returns the offset of the keyway. More...
double	PadHeight ()
	Returns the pad height of the keyway. More...
double	PadWidth ()
	Returns the pad width of the keyway. More...
double	PlacementOffset ()
	Returns the placement offset of the keyway. More...
NXOpen::IOrientation *	Plane ()
	Returns the plane of the keyway. More...
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. More...
double	RunoffDepth ()
	Returns the runoff depth of the keyway. More...
double	RunoffDiameter ()
	Returns the runoff diameter of the keyway. More...
double	RunoffLength ()
	Returns the runoff length of the keyway. More...
NXOpen::Die::KeywayChildBuilder::RunoffTypeOption	RunoffType ()
	Returns the runoff type of the keyway. More...
double	RunoffWidth ()
	Returns the runoff width of the keyway. More...
void	SetDepth (double depth)
	Sets the depth of the keyway. More...
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. More...
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. More...
void	SetLength (double length)
	Sets the length of the keyway. More...
void	SetLocation (NXOpen::Die::KeywayChildBuilder::LocationOption location)
	Sets the location of the keyway. More...
void	SetMinimumRibHeight (double minimumRibHeight)
	Sets the minimum rib height of the keyway. More...
void	SetOffset (double offset)
	Sets the offset of the keyway. 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	SetPadHeight (double padHeight)
	Sets the pad height of the keyway. More...
void	SetPadWidth (double padWidth)
	Sets the pad width of the keyway. More...
void	SetPlacementOffset (double placementOffset)
	Sets the placement offset of the keyway. More...
void	SetPlane (NXOpen::IOrientation *plane)
	Sets the plane of the keyway. More...
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. More...
void	SetRunoffDepth (double runoffDepth)
	Sets the runoff depth of the keyway. More...
void	SetRunoffDiameter (double runoffDiameter)
	Sets the runoff diameter of the keyway. More...
void	SetRunoffLength (double runoffLength)
	Sets the runoff length of the keyway. More...
void	SetRunoffType (NXOpen::Die::KeywayChildBuilder::RunoffTypeOption runoffType)
	Sets the runoff type of the keyway. More...
void	SetRunoffWidth (double runoffWidth)
	Sets the runoff width of the keyway. More...
void	SetSlotAttributes (const NXString &title, const NXString &value, int color)
	Sets the slot attributes, note existance of attributes depends on usage in main feature. More...
void	SetSlotAttributes (const char *title, const char *value, int color)
	Sets the slot attributes, note existance of attributes depends on usage in main feature. More...
void	SetWidth (double width)
	Sets the width of the keyway. More...
double	Width ()
	Returns the width of the keyway. More...
Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::Feature *	CommitFeature ()
	Commits the feature parameters and creates the feature. More...
NXOpen::Features::Feature *	GetFeature ()
	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::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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 Keyway Child sub feature.

This sub feature is created via the main feature builder.

Created in NX4.0.0.

Member Enumeration Documentation

enum NXOpen::Die::KeywayChildBuilder::LocationOption

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.

enum NXOpen::Die::KeywayChildBuilder::RunoffTypeOption

Settings for the runoff type of the keyway.

Enumerator
RunoffTypeOptionRectangular	Rectangular runoff.
RunoffTypeOptionCircular	Circular runoff.

Member Function Documentation

NXOpen::Die::DieBuildStatusOption NXOpen::Die::KeywayChildBuilder::BuildStatus

(

)

Returns the build status of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::KeywayChildBuilder::Depth

(

)

Returns the depth of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

bool NXOpen::Die::KeywayChildBuilder::DesignStatus

(

)

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

bool NXOpen::Die::KeywayChildBuilder::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.

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

title	Title for attribute.
value	Value of attribute.
color	Color 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

title	Title for attribute.
value	Value of attribute.
color	Color of slot faces.

double NXOpen::Die::KeywayChildBuilder::Length

(

)

Returns the length of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

NXOpen::Die::KeywayChildBuilder::LocationOption NXOpen::Die::KeywayChildBuilder::Location

(

)

Returns the location of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::KeywayChildBuilder::MinimumRibHeight

(

)

Returns the minimum rib height of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::KeywayChildBuilder::Offset

(

)

Returns the offset of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::KeywayChildBuilder::PadHeight

(

)

Returns the pad height of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::KeywayChildBuilder::PadWidth

(

)

Returns the pad width of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::KeywayChildBuilder::PlacementOffset

(

)

Returns the placement offset of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

NXOpen::IOrientation* NXOpen::Die::KeywayChildBuilder::Plane

(

)

Returns the plane of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

bool NXOpen::Die::KeywayChildBuilder::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.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::KeywayChildBuilder::RunoffDepth

(

)

Returns the runoff depth of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::KeywayChildBuilder::RunoffDiameter

(

)

Returns the runoff diameter of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::KeywayChildBuilder::RunoffLength

(

)

Returns the runoff length of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

NXOpen::Die::KeywayChildBuilder::RunoffTypeOption NXOpen::Die::KeywayChildBuilder::RunoffType

(

)

Returns the runoff type of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

double NXOpen::Die::KeywayChildBuilder::RunoffWidth

(

)

Returns the runoff width of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

void NXOpen::Die::KeywayChildBuilder::SetDepth

(

double

depth

)

Sets the depth of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

depth

depth

void NXOpen::Die::KeywayChildBuilder::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.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

designStatus

design status

void NXOpen::Die::KeywayChildBuilder::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.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

displayStatus

display status

void NXOpen::Die::KeywayChildBuilder::SetLength

(

double

length

)

Sets the length of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

length

length

void NXOpen::Die::KeywayChildBuilder::SetLocation

(

NXOpen::Die::KeywayChildBuilder::LocationOption

location

)

Sets the location of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

location

location

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

minimumRibHeight

minimum rib height

void NXOpen::Die::KeywayChildBuilder::SetOffset

(

double

offset

)

Sets the offset of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

offset

offset

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

title	Title for attribute.
value	Value of attribute.
color	Color of pad faces.

void NXOpen::Die::KeywayChildBuilder::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

title	Title for attribute.
value	Value of attribute.
color	Color of pad faces.

void NXOpen::Die::KeywayChildBuilder::SetPadHeight

(

double

padHeight

)

Sets the pad height of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

padHeight

pad height

void NXOpen::Die::KeywayChildBuilder::SetPadWidth

(

double

padWidth

)

Sets the pad width of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

padWidth

pad 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

placementOffset

placement offset

void NXOpen::Die::KeywayChildBuilder::SetPlane

(

NXOpen::IOrientation *

plane

)

Sets the plane of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

plane

plane

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

reverseOrientation

reverse orientation

void NXOpen::Die::KeywayChildBuilder::SetRunoffDepth

(

double

runoffDepth

)

Sets the runoff depth of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

runoffDepth

runoff 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

runoffDiameter

runoff 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

runoffLength

runoff length

void NXOpen::Die::KeywayChildBuilder::SetRunoffType

(

NXOpen::Die::KeywayChildBuilder::RunoffTypeOption

runoffType

)

Sets the runoff type of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

runoffType

runoff type

void NXOpen::Die::KeywayChildBuilder::SetRunoffWidth

(

double

runoffWidth

)

Sets the runoff width of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

runoffWidth

runoff 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

title	Title for attribute.
value	Value of attribute.
color	Color of slot faces.

void NXOpen::Die::KeywayChildBuilder::SetSlotAttributes	(	const char *	title,
		const char *	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

title	Title for attribute.
value	Value of attribute.
color	Color of slot faces.

void NXOpen::Die::KeywayChildBuilder::SetWidth

(

double

width

)

Sets the width of the keyway.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

width

width

double NXOpen::Die::KeywayChildBuilder::Width

(

)

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:

• Die_KeywayChildBuilder.hxx