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

Inheritance diagram for NXOpen::Die::ThroatParentBuilder:

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 sections.

NXOpen::Die::ThroatChildBuilder *	CreateChild ()
	Creates a child throat section.

void	DeleteChild (NXOpen::Die::ThroatChildBuilder *diethroatchild)
	Deletes a child throat section.

bool	DesignStatus ()
	Returns the design status of the throat sections, if true the throat sections will be built into the model, if false they will not.

bool	DisplayStatus ()
	Returns the display status of the throat sections, if true input data to the throat sections will be displayed, if false the input data will not be displayed.

void	GetCavityAttributes (NXString title, NXString value, int *color)
	Gets the cavity attributes, note existance of attributes depends on usage in main feature.

std::vector < NXOpen::Die::ThroatChildBuilder * >	GetChildren ()
	Outputs the child throat sections.

void	GetExtensionAttributes (NXString title, NXString value, int *color)
	Gets the extension attributes, note existance of attributes depends on usage in main feature.

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

void	SetCavityAttributes (const NXString &title, const NXString &value, int color)
	Sets the cavity attributes, note existance of attributes depends on usage in main feature.

void	SetCavityAttributes (const char title, const char value, int color)
	Sets the cavity attributes, note existance of attributes depends on usage in main feature.

void	SetDesignStatus (bool designStatus)
	Sets the design status of the throat sections, if true the throat sections will be built into the model, if false they will not.

void	SetDisplayStatus (bool displayStatus)
	Sets the display status of the throat sections, if true input data to the throat sections will be displayed, if false the input data will not be displayed.

void	SetExtensionAttributes (const NXString &title, const NXString &value, int color)
	Sets the extension attributes, note existance of attributes depends on usage in main feature.

void	SetExtensionAttributes (const char title, const char value, int color)
	Sets the extension attributes, note existance of attributes depends on usage in main feature.

void	SetRadius (double radius)
	Sets the radius to be applied at the back of the throat, top and bottom Created in NX4.0.0.

void	SetStep (double step)
	Sets the step to be applied at the end of the tangential extension of the flange Created in NX4.0.0.

void	SetType (NXOpen::Die::ThroatParentBuilder::TypeOption type)
	Sets the type of throat sections.

double	Step ()
	Returns the step to be applied at the end of the tangential extension of the flange Created in NX4.0.0.

NXOpen::Die::ThroatParentBuilder::TypeOption	Type ()
	Returns the type of throat sections.

Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::Feature *	CommitFeature ()
	Commits the feature parameters and creates the feature.

NXOpen::Features::Feature *	GetFeature ()
	Returns the feature currently being edited by this builder.

void	HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
	Re-suppress an internal parent feature (a slave feature) after it has been edited.

bool	ParentFeatureInternal ()
	Returns whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0.

bool	PatchSolutionFlag ()
	Returns the patch solution flag Created in NX8.0.1.

NXString	PatchSurfaceFilename ()
	Returns the patch surface filename Created in NX8.0.1.

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.

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.

void	SetPatchSolutionFlag (bool optionValue)
	Sets the patch solution flag Created in NX8.0.1.

void	SetPatchSurfaceFilename (const NXString &surfaceFilename)
	Sets the patch surface filename Created in NX8.0.1.

void	SetPatchSurfaceFilename (const char *surfaceFilename)
	Sets the patch surface filename Created in NX8.0.1.

void	SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
	Sets the surrounding patch surface filename Created in NX8.0.1.

void	SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
	Sets the surrounding patch surface filename Created in NX8.0.1.

void	ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
	Unsuppress an internal parent feature (a slave feature) so it can be edited.

NXString	SurroundingPatchSurfaceFilename ()
	Returns the surrounding patch surface filename Created in NX8.0.1.

void	UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
	Set the internal parent feature of the feature being edited to external Created in NX6.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Die Throat Parent sub feature.

This sub feature is created via the main feature builder.

Created in NX4.0.0.

Member Enumeration Documentation

enum NXOpen::Die::ThroatParentBuilder::TypeOption

Settings for the type of the throat section.

Enumerator:

TypeOptionWipe	Throat is built for a wipe operation.
TypeOptionRestrike	Throat is built for a restrike operation.

Member Function Documentation

NXOpen::Die::DieBuildStatusOption NXOpen::Die::ThroatParentBuilder::BuildStatus ( )

Returns the build status of the throat sections.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

NXOpen::Die::ThroatChildBuilder* NXOpen::Die::ThroatParentBuilder::CreateChild ( )

Creates a child throat section.

Returns: Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

void NXOpen::Die::ThroatParentBuilder::DeleteChild ( NXOpen::Die::ThroatChildBuilder * diethroatchild )

Deletes a child throat section.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

diethroatchild diethroatchild

bool NXOpen::Die::ThroatParentBuilder::DesignStatus ( )

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

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

bool NXOpen::Die::ThroatParentBuilder::DisplayStatus ( )

Returns the display status of the throat sections, if true input data to the throat sections 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::ThroatParentBuilder::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

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

std::vector<NXOpen::Die::ThroatChildBuilder *> NXOpen::Die::ThroatParentBuilder::GetChildren ( )

Outputs the child throat sections.

Returns: The child throat sections.
Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

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

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

double NXOpen::Die::ThroatParentBuilder::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")

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

title	Title for attribute. NOTE: The full Unicode character set is not supported for this parameter.
value	Value of attribute. NOTE: The full Unicode character set is not supported for this parameter.
color	Color of cavity faces.

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

title	Title for attribute. NOTE: The full Unicode character set is not supported for this parameter.
value	Value of attribute. NOTE: The full Unicode character set is not supported for this parameter.
color	Color of cavity faces.

void NXOpen::Die::ThroatParentBuilder::SetDesignStatus ( bool designStatus )

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

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

designStatus design status

void NXOpen::Die::ThroatParentBuilder::SetDisplayStatus ( bool displayStatus )

Sets the display status of the throat sections, if true input data to the throat sections 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::ThroatParentBuilder::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

title	Title for attribute. NOTE: The full Unicode character set is not supported for this parameter.
value	Value of attribute. NOTE: The full Unicode character set is not supported for this parameter.
color	Color of extension faces.

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

title	Title for attribute. NOTE: The full Unicode character set is not supported for this parameter.
value	Value of attribute. NOTE: The full Unicode character set is not supported for this parameter.
color	Color of extension faces.

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

radius radius

void NXOpen::Die::ThroatParentBuilder::SetStep ( double step )

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

License requirements : ug_die_design ("Die Design")

Parameters

step step

void NXOpen::Die::ThroatParentBuilder::SetType ( NXOpen::Die::ThroatParentBuilder::TypeOption type )

Sets the type of throat sections.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

Parameters

type type

double NXOpen::Die::ThroatParentBuilder::Step ( )

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

License requirements : ug_die_design ("Die Design")

NXOpen::Die::ThroatParentBuilder::TypeOption NXOpen::Die::ThroatParentBuilder::Type ( )

Returns the type of throat sections.

Created in NX4.0.0.

License requirements : ug_die_design ("Die Design")

The documentation for this class was generated from the following file:

Die_ThroatParentBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation