NX Open C++ Reference Guide
Public Member Functions
NXOpen::CAM::UdeParameter Class Reference

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

Inheritance diagram for NXOpen::CAM::UdeParameter:
NXOpen::TaggedObject

List of all members.

Public Member Functions

bool BooleanValue ()
 Returns the boolean value of the parameter
Created in NX7.5.0.
double DoubleValue ()
 Returns the double value of the parameter
Created in NX7.5.0.
int IntegerValue ()
 Returns the integer value of the parameter
Created in NX7.5.0.
NXString NameOfParameter ()
 Returns the name of the parameter
Created in NX7.5.0.
NXString OptionText ()
 Returns the option utf8 value of the parameter
Created in NX8.0.0.
NXString OptionValue ()
 Returns the option value of the parameter

bool ParameterActive ()
 Returns the check to see if paramter is active
Created in NX7.5.0.
bool ParameterOptional ()
 Returns the check to see if the parameter is optional
Created in NX7.5.0.
NXOpen::PointPoint ()
 Returns the point of the parameter
Created in NX7.5.0.
void SetBooleanValue (bool booleanValue)
 Sets the boolean value of the parameter
Created in NX7.5.0.
void SetDoubleValue (double doubleValue)
 Sets the double value of the parameter
Created in NX7.5.0.
void SetIntegerValue (int integerValue)
 Sets the integer value of the parameter
Created in NX7.5.0.
void SetOptionText (const NXString &optionValue)
 Sets the option utf8 value of the parameter
Created in NX8.0.0.
void SetOptionValue (const NXString &optionValue)
 Sets the option value of the parameter

void SetParameterActive (bool parameterActive)
 Sets the check to see if paramter is active
Created in NX7.5.0.
void SetPoint (NXOpen::Point *tagValue)
 Sets the point of the parameter
Created in NX7.5.0.
void SetStringText (const NXString &stringValue)
 Sets the string utf8 value of the parameter
Created in NX8.0.0.
void SetStringValue (const NXString &stringValue)
 Sets the string value of the parameter

void SetVector (NXOpen::NXObject *tagValue)
 Sets the vector of the parameter
Created in NX7.5.0.
NXString StringText ()
 Returns the string utf8 value of the parameter
Created in NX8.0.0.
NXString StringValue ()
 Returns the string value of the parameter

NXOpen::NXObjectVector ()
 Returns the vector of the parameter
Created in NX7.5.0.

Detailed Description

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



Member Function Documentation

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

Returns the option value of the parameter

Deprecated:
Deprecated in NX8.0.0.



Created in NX7.5.0.

License requirements : None

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



License requirements : None

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



License requirements : None

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:
booleanValueboolean 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:
doubleValuedouble 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:
integerValueinteger 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:
optionValueoption 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.



Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters:
optionValueoption 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:
parameterActiveparameter is active

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



License requirements : cam_base ("CAM BASE")

Parameters:
tagValuetagvalue
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:
stringValuestring 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.



Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters:
stringValuestring value of the parameter

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



License requirements : cam_base ("CAM BASE")

Parameters:
tagValuetagvalue

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



License requirements : None

Returns the string value of the parameter

Deprecated:
Deprecated in NX8.0.0.



Created in NX7.5.0.

License requirements : None

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.