Represents a User Defined Event Parameter
Created in NX7.5.0. More...

Inheritance diagram for NXOpen::CAM::UdeParameter:

Public Types
enum	ParameterTypes { ParameterTypesInteger, ParameterTypesDouble, ParameterTypesBoolean, ParameterTypesString, ParameterTypesOption, ParameterTypesPoint, ParameterTypesVector, ParameterTypesLegend, ParameterTypesGroup }
	the parameter Type More...

Public Member Functions
bool	BooleanValue ()
	Returns the boolean value of the parameter Created in NX7.5.0. More...

double	DoubleValue ()
	Returns the double value of the parameter Created in NX7.5.0. More...

int	IntegerValue ()
	Returns the integer value of the parameter Created in NX7.5.0. More...

NXString	NameOfParameter ()
	Returns the name of the parameter Created in NX7.5.0. More...

NXString	OptionText ()
	Returns the option utf8 value of the parameter Created in NX8.0.0. More...

NXString	OptionValue ()
	Returns the option value of the parameter More...

bool	ParameterActive ()
	Returns the check to see if paramter is active Created in NX7.5.0. More...

bool	ParameterOptional ()
	Returns the check to see if the parameter is optional Created in NX7.5.0. More...

NXOpen::Point *	Point ()
	Returns the point of the parameter Created in NX7.5.0. More...

void	SetBooleanValue (bool booleanValue)
	Sets the boolean value of the parameter Created in NX7.5.0. More...

void	SetDoubleValue (double doubleValue)
	Sets the double value of the parameter Created in NX7.5.0. More...

void	SetIntegerValue (int integerValue)
	Sets the integer value of the parameter Created in NX7.5.0. More...

void	SetOptionText (const NXString &optionValue)
	Sets the option utf8 value of the parameter Created in NX8.0.0. More...

void	SetOptionText (const char *optionValue)
	Sets the option utf8 value of the parameter Created in NX8.0.0. More...

void	SetOptionValue (const NXString &optionValue)
	Sets the option value of the parameter More...

void	SetOptionValue (const char *optionValue)
	Sets the option value of the parameter More...

void	SetParameterActive (bool parameterActive)
	Sets the check to see if paramter is active Created in NX7.5.0. More...

void	SetPoint (NXOpen::Point *tagValue)
	Sets the point of the parameter Created in NX7.5.0. More...

void	SetStringText (const NXString &stringValue)
	Sets the string utf8 value of the parameter Created in NX8.0.0. More...

void	SetStringText (const char *stringValue)
	Sets the string utf8 value of the parameter Created in NX8.0.0. More...

void	SetStringValue (const NXString &stringValue)
	Sets the string value of the parameter More...

void	SetStringValue (const char *stringValue)
	Sets the string value of the parameter More...

void	SetVector (NXOpen::NXObject *tagValue)
	Sets the vector of the parameter Created in NX7.5.0. More...

NXString	StringText ()
	Returns the string utf8 value of the parameter Created in NX8.0.0. More...

NXString	StringValue ()
	Returns the string value of the parameter More...

NXOpen::CAM::UdeParameter::ParameterTypes	TypeOfParameter ()
	Returns the type of the parameter Created in NX10.0.1. More...

NXOpen::NXObject *	Vector ()
	Returns the vector of the parameter Created in NX7.5.0. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a User Defined Event Parameter
Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::CAM::UdeParameter::ParameterTypes

the parameter Type

Enumerator
ParameterTypesInteger	integer
ParameterTypesDouble	double
ParameterTypesBoolean	boolean
ParameterTypesString	string
ParameterTypesOption	option
ParameterTypesPoint	point
ParameterTypesVector	vector
ParameterTypesLegend	legend
ParameterTypesGroup	group

Member Function Documentation

bool NXOpen::CAM::UdeParameter::BooleanValue ( )

Returns the boolean value of the parameter
Created in NX7.5.0.

License requirements : None

double NXOpen::CAM::UdeParameter::DoubleValue ( )

Returns the double value of the parameter
Created in NX7.5.0.

License requirements : None

int NXOpen::CAM::UdeParameter::IntegerValue ( )

Returns the integer value of the parameter
Created in NX7.5.0.

License requirements : None

NXString NXOpen::CAM::UdeParameter::NameOfParameter ( )

Returns the name of the parameter
Created in NX7.5.0.

License requirements : None

NXString NXOpen::CAM::UdeParameter::OptionText ( )

Returns the option utf8 value of the parameter
Created in NX8.0.0.

License requirements : None

NXString NXOpen::CAM::UdeParameter::OptionValue ( )

Returns the option value of the parameter

Deprecated:: Deprecated in NX8.0.0.

Use CAM::UdeParameter::OptionText and CAM::UdeParameter::SetOptionText instead.

Created in NX7.5.0.

License requirements : None

bool NXOpen::CAM::UdeParameter::ParameterActive ( )

Returns the check to see if paramter is active
Created in NX7.5.0.

License requirements : None

bool NXOpen::CAM::UdeParameter::ParameterOptional ( )

Returns the check to see if the parameter is optional
Created in NX7.5.0.

License requirements : None

NXOpen::Point* NXOpen::CAM::UdeParameter::Point ( )

Returns the point of the parameter
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::UdeParameter::SetBooleanValue ( bool booleanValue )

Sets the boolean value of the parameter
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

booleanValue boolean value of the parameter

void NXOpen::CAM::UdeParameter::SetDoubleValue ( double doubleValue )

Sets the double value of the parameter
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

doubleValue double value of the parameter

void NXOpen::CAM::UdeParameter::SetIntegerValue ( int integerValue )

Sets the integer value of the parameter
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

integerValue integer value of the parameter

void NXOpen::CAM::UdeParameter::SetOptionText ( const NXString & optionValue )

Sets the option utf8 value of the parameter
Created in NX8.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

optionValue option value of the parameter

void NXOpen::CAM::UdeParameter::SetOptionText ( const char * optionValue )

Sets the option utf8 value of the parameter
Created in NX8.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

optionValue option value of the parameter

void NXOpen::CAM::UdeParameter::SetOptionValue ( const NXString & optionValue )

Sets the option value of the parameter

Deprecated:: Deprecated in NX8.0.0.

Use CAM::UdeParameter::OptionText and CAM::UdeParameter::SetOptionText instead.

Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

optionValue option value of the parameter

void NXOpen::CAM::UdeParameter::SetOptionValue ( const char * optionValue )

Sets the option value of the parameter

Deprecated:: Deprecated in NX8.0.0.

Use CAM::UdeParameter::OptionText and CAM::UdeParameter::SetOptionText instead.

Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

optionValue option value of the parameter

void NXOpen::CAM::UdeParameter::SetParameterActive ( bool parameterActive )

Sets the check to see if paramter is active
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

parameterActive parameter is active

void NXOpen::CAM::UdeParameter::SetPoint ( NXOpen::Point * tagValue )

Sets the point of the parameter
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

tagValue tagvalue

void NXOpen::CAM::UdeParameter::SetStringText ( const NXString & stringValue )

Sets the string utf8 value of the parameter
Created in NX8.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

stringValue string value of the parameter

void NXOpen::CAM::UdeParameter::SetStringText ( const char * stringValue )

Sets the string utf8 value of the parameter
Created in NX8.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

stringValue string value of the parameter

void NXOpen::CAM::UdeParameter::SetStringValue ( const NXString & stringValue )

Sets the string value of the parameter

Deprecated:: Deprecated in NX8.0.0.

Use CAM::UdeParameter::StringText and CAM::UdeParameter::SetStringText instead.

Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

stringValue string value of the parameter

void NXOpen::CAM::UdeParameter::SetStringValue ( const char * stringValue )

Sets the string value of the parameter

Deprecated:: Deprecated in NX8.0.0.

Use CAM::UdeParameter::StringText and CAM::UdeParameter::SetStringText instead.

Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

stringValue string value of the parameter

void NXOpen::CAM::UdeParameter::SetVector ( NXOpen::NXObject * tagValue )

Sets the vector of the parameter
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

tagValue tagvalue

NXString NXOpen::CAM::UdeParameter::StringText ( )

Returns the string utf8 value of the parameter
Created in NX8.0.0.

License requirements : None

NXString NXOpen::CAM::UdeParameter::StringValue ( )

Returns the string value of the parameter

Deprecated:: Deprecated in NX8.0.0.

Use CAM::UdeParameter::StringText and CAM::UdeParameter::SetStringText instead.

Created in NX7.5.0.

License requirements : None

NXOpen::CAM::UdeParameter::ParameterTypes NXOpen::CAM::UdeParameter::TypeOfParameter ( )

Returns the type of the parameter
Created in NX10.0.1.

License requirements : None

NXOpen::NXObject* NXOpen::CAM::UdeParameter::Vector ( )

Returns the vector of the parameter
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

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

CAM_UdeParameter.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation