CIP C++ documentation for class "pfcParamValue"

Class pfcParamValue

# include <pfcModelItem.h> class pfcParamValue : public xobject { xdeclare(pfcParamValue) ... }; This is a COMPACT class.

Description

This class describes the value of the parameter.

This determines the type of parameter.

Manual References:: Dimensions and Parameters: The ParamValue Object, Dimensions and Parameters: Accessing a ParamValue Object, Dimensions and Parameters: Accessing the ParamValue Value, Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options, Family Tables: Accessing Cell Information, Overview of Creo Object TOOLKIT C++: Union Classes

Method Summary


`xbool`	`GetBoolValue ()`
`void`	`SetBoolValue (xbool value)`
	If the parameter type is PARAM_BOOLEAN, this is a Boolean value.

`pfcParamValueType`	`Getdiscr ()`
	Returns the union discriminant value.

`xreal`	`GetDoubleValue ()`
`void`	`SetDoubleValue (xreal value)`
	If the parameter type is PARAM_DOUBLE, this is a double value.

`xint`	`GetIntValue ()`
`void`	`SetIntValue (xint value)`
	If the parameter type is PARAM_INTEGER, this is an integer value.

`xint`	`GetNoteId ()`
`void`	`SetNoteId (xint value)`
	If the parameter type is PARAM_NOTE, this is a note identifier.

`xstring`	`GetStringValue ()`
`void`	`SetStringValue (xrstring value)`
	If the parameter type is PARAM_STRING, this is a string value.

Method Detail

pfcParamValueType Getdiscr ()

Returns the union discriminant value.

`xstring`	`GetStringValue`	`()`
`void`	`SetStringValue`	`(xrstring value)`

If the parameter type is PARAM_STRING, this is a string value.

Exceptions thrown (but not limited to):

pfcXBadGetParamValue - Parameter value is not string

Manual References:: Dimensions and Parameters: Accessing the ParamValue Value, Family Tables: Accessing Cell Information, Family Tables: Accessing Cell Information, Dimensions and Parameters: Accessing the ParamValue Value

`xint`	`GetIntValue`	`()`
`void`	`SetIntValue`	`(xint value)`

If the parameter type is PARAM_INTEGER, this is an integer value.

Exceptions thrown (but not limited to):

pfcXBadGetParamValue - Parameter value is not an integer

Manual References:: Dimensions and Parameters: Accessing the ParamValue Value, Family Tables: Accessing Cell Information, Family Tables: Accessing Cell Information, Dimensions and Parameters: Accessing the ParamValue Value

`xbool`	`GetBoolValue`	`()`
`void`	`SetBoolValue`	`(xbool value)`

If the parameter type is PARAM_BOOLEAN, this is a Boolean value.

Exceptions thrown (but not limited to):

pfcXBadGetParamValue - Parameter value is not boolean

Manual References:: Dimensions and Parameters: Accessing the ParamValue Value, Family Tables: Accessing Cell Information, Dimensions and Parameters: Accessing the ParamValue Value

`xreal`	`GetDoubleValue`	`()`
`void`	`SetDoubleValue`	`(xreal value)`

If the parameter type is PARAM_DOUBLE, this is a double value.

Exceptions thrown (but not limited to):

pfcXBadGetParamValue - Parameter value is not double

Manual References:: Dimensions and Parameters: Accessing the ParamValue Value, Family Tables: Accessing Cell Information, Family Tables: Accessing Cell Information, Dimensions and Parameters: Accessing the ParamValue Value

`xint`	`GetNoteId`	`()`
`void`	`SetNoteId`	`(xint value)`

If the parameter type is PARAM_NOTE, this is a note identifier.

Exceptions thrown (but not limited to):

pfcXBadGetParamValue - Parameter value is not a note identifier

Manual References:: Dimensions and Parameters: Accessing the ParamValue Value, Overview of Creo Object TOOLKIT C++: Union Classes, Overview of Creo Object TOOLKIT C++: Union Classes