This class is used to create a new event item. More...

Inheritance diagram for NXOpen::SIM::PostConfigurator::UdeParameterBuilder:

Public Types
enum	GroupStateType { GroupStateTypeOpen, GroupStateTypeClosed, GroupStateTypeEnd }
	Type of Group State. More...

enum	ParameterStatusType { ParameterStatusTypeNone, ParameterStatusTypeOn, ParameterStatusTypeOff }
	Type of Event Parameter Status. More...

enum	Type { TypeGroup, TypeDouble, TypeInteger, TypeString, TypeBoolean, TypeEnumeration, TypeVector, TypePoint, TypeBitmap }
	Type of Event Item. More...

Public Member Functions
double	DoubleDefaultValue ()
	Returns the double default value Created in NX12.0.1. More...

NXString	EnumerationDefaultValue ()
	Returns the enumumeration item default value Created in NX12.0.1. More...

std::vector< NXString >	GetEnumerationItems ()
	Gets a list of enumeration items. More...

NXOpen::SIM::PostConfigurator::UdeParameterBuilder::GroupStateType	GroupState ()
	Returns the group state Created in NX12.0.1. More...

int	IntegerDefaultValue ()
	Returns the integer default value Created in NX12.0.1. More...

NXOpen::SIM::PostConfigurator::UdeParameterBuilder::Type	ItemType ()
	Returns the item type Created in NX12.0.1. More...

NXString	ParameterID ()
	Returns the parameter ID Created in NX12.0.1. More...

NXOpen::SIM::PostConfigurator::UdeParameterBuilder::ParameterStatusType	ParameterStatus ()
	Returns the item status Created in NX12.0.1. More...

void	SetDoubleDefaultValue (double doubleDefaultValue)
	Sets the double default value Created in NX12.0.1. More...

void	SetEnumerationDefaultValue (const NXString &enumerationDefaultValue)
	Sets the enumumeration item default value Created in NX12.0.1. More...

void	SetEnumerationDefaultValue (const char *enumerationDefaultValue)
	Sets the enumumeration item default value Created in NX12.0.1. More...

void	SetEnumerationItems (std::vector< NXString > &enumerationItems)
	Sets a list of enumeration items Created in NX12.0.1. More...

void	SetGroup (NXOpen::SIM::PostConfigurator::UdeParameterBuilder *parentBuilder)
	Sets the ude parameter builder group Created in NX12.0.1. More...

void	SetGroupState (NXOpen::SIM::PostConfigurator::UdeParameterBuilder::GroupStateType state)
	Sets the group state Created in NX12.0.1. More...

void	SetIntegerDefaultValue (int integerDefaultValue)
	Sets the integer default value Created in NX12.0.1. More...

void	SetItemType (NXOpen::SIM::PostConfigurator::UdeParameterBuilder::Type itemType)
	Sets the item type Created in NX12.0.1. More...

void	SetParameterID (const NXString &paramID)
	Sets the parameter ID Created in NX12.0.1. More...

void	SetParameterID (const char *paramID)
	Sets the parameter ID Created in NX12.0.1. More...

void	SetParameterStatus (NXOpen::SIM::PostConfigurator::UdeParameterBuilder::ParameterStatusType parameterStatus)
	Sets the item status Created in NX12.0.1. More...

void	SetStringDefaultValue (const NXString &stringDefaultValue)
	Sets the string default value Created in NX12.0.1. More...

void	SetStringDefaultValue (const char *stringDefaultValue)
	Sets the string default value Created in NX12.0.1. More...

void	SetToggleDefaultValue (bool toggleDefaultValue)
	Sets the toggle default value Created in NX12.0.1. More...

void	SetUILabel (const NXString &uiLabel)
	Sets the User Interface Label Created in NX12.0.1. More...

void	SetUILabel (const char *uiLabel)
	Sets the User Interface Label Created in NX12.0.1. More...

NXString	StringDefaultValue ()
	Returns the string default value Created in NX12.0.1. More...

bool	ToggleDefaultValue ()
	Returns the toggle default value Created in NX12.0.1. More...

NXString	UILabel ()
	Returns the User Interface Label Created in NX12.0.1. 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

This class is used to create a new event item.

Calling Builder::Commit on this builder will only return NULL.
To create a new instance of this class, use NXOpen::SIM::PostConfigurator::PostConfiguratorManager::CreateUdeParameterBuilder

Created in NX12.0.1.

Member Enumeration Documentation

enum NXOpen::SIM::PostConfigurator::UdeParameterBuilder::GroupStateType

Type of Group State.

Enumerator
GroupStateTypeOpen	Open.
GroupStateTypeClosed	Closed.
GroupStateTypeEnd	End.

enum NXOpen::SIM::PostConfigurator::UdeParameterBuilder::ParameterStatusType

Type of Event Parameter Status.

Enumerator
ParameterStatusTypeNone	None - Text Status is Invisible.
ParameterStatusTypeOn	On - Text Status is Activate.
ParameterStatusTypeOff	Off - Text Status is Deactivate.

enum NXOpen::SIM::PostConfigurator::UdeParameterBuilder::Type

Type of Event Item.

Enumerator
TypeGroup	Group.
TypeDouble	Double.
TypeInteger	Integer.
TypeString	String.
TypeBoolean	Boolean.
TypeEnumeration	Enumeration.
TypeVector	Vector.
TypePoint	Point.
TypeBitmap	Bitmap.

Member Function Documentation

double NXOpen::SIM::PostConfigurator::UdeParameterBuilder::DoubleDefaultValue ( )

Returns the double default value
Created in NX12.0.1.

License requirements : None

NXString NXOpen::SIM::PostConfigurator::UdeParameterBuilder::EnumerationDefaultValue ( )

Returns the enumumeration item default value
Created in NX12.0.1.

License requirements : None

std::vector<NXString> NXOpen::SIM::PostConfigurator::UdeParameterBuilder::GetEnumerationItems ( )

Gets a list of enumeration items.

Returns: the list of enumeration items
Created in NX12.0.1.

License requirements : None

NXOpen::SIM::PostConfigurator::UdeParameterBuilder::GroupStateType NXOpen::SIM::PostConfigurator::UdeParameterBuilder::GroupState ( )

Returns the group state
Created in NX12.0.1.

License requirements : None

int NXOpen::SIM::PostConfigurator::UdeParameterBuilder::IntegerDefaultValue ( )

Returns the integer default value
Created in NX12.0.1.

License requirements : None

NXOpen::SIM::PostConfigurator::UdeParameterBuilder::Type NXOpen::SIM::PostConfigurator::UdeParameterBuilder::ItemType ( )

Returns the item type
Created in NX12.0.1.

License requirements : None

NXString NXOpen::SIM::PostConfigurator::UdeParameterBuilder::ParameterID ( )

Returns the parameter ID
Created in NX12.0.1.

License requirements : None

NXOpen::SIM::PostConfigurator::UdeParameterBuilder::ParameterStatusType NXOpen::SIM::PostConfigurator::UdeParameterBuilder::ParameterStatus ( )

Returns the item status
Created in NX12.0.1.

License requirements : None

void NXOpen::SIM::PostConfigurator::UdeParameterBuilder::SetDoubleDefaultValue ( double doubleDefaultValue )

Sets the double default value
Created in NX12.0.1.