CIP C++ documentation for class "pfcParameter"

Class pfcParameter

# include <pfcModelItem.h> class pfcParameter : public virtual pfcBaseParameter, : public virtual pfcNamedModelItem { xaideclare(pfcParameter) ... };

Description

This class defines a parameter object.

Manual References:: Dimensions and Parameters: Parameter Selection Options, Family Tables: Accessing Columns, Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Direct Known Subclasses:: wfcWParameter

Method Summary


`void`	`Delete ()`
	Deletes a parameter.

`optional xstring`	`GetDescription ()`
`void`	`SetDescription (optional xrstring value)`
	Parameter description string.

`optional pfcParameterDriverType`	`GetDriverType ()`
	Obtains the type of driver for a material parameter.

`optional pfcParameterRestriction_ptr`	`GetRestriction ()`
	Identifies if a parameter's value is restricted to a certain range or enumerated.

`pfcParamValue_ptr`	`GetScaledValue ()`
	Gets the parameter value in the units of the parameter, instead of the units of the owner model.

`optional pfcUnit_ptr`	`GetUnits ()`
	Units assigned to the parameter.

`void`	`Reorder (optional pfcParameter_ptr ParamBefore)`
	Reorders the given parameter to come just after the indicated parameter.



`void`	`SetScaledValue (pfcParamValue_ptr value, optional pfcUnit_ptr Units)`
	Sets the parameter value in terms of the units provided, instead of using the units of the owner model.

Methods Inherited from Class pfcBaseParameter:: GetValue, SetValue, GetIsDesignated, SetIsDesignated, GetIsRelationDriven, GetIsModified, ResetFromBackup

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcNamedModelItem:: GetName

Method Detail

void Delete ()

Deletes a parameter.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The owner was not found.

Manual References:: Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options

Returns:

optional pfcUnit_ptr GetUnits ()

Units assigned to the parameter.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The parameter is unitless.

Manual References:: Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options

pfcParamValue_ptr GetScaledValue ()

Gets the parameter value in the units of the parameter, instead of the units of the owner model.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The owner was not found.

Manual References:: Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options

Returns:: The parameter scaled value.

void SetScaledValue (pfcParamValue_ptr value, optional pfcUnit_ptr Units)

Sets the parameter value in terms of the units provided, instead of using the units of the owner model.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The owner was not found.

pfcXToolkitInvalidType - The unit type provided does not match the units of the parameter.

Manual References:: Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options

Parameters:

value: The value of the parameter to be set.
Units: The units in which the value is expressed. The value can be null.

Returns:

`optional xstring`	`GetDescription`	`()`
`void`	`SetDescription`	`(optional xrstring value)`

Parameter description string.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The parameter's description is not set.

Manual References:: Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options

void Reorder (optional pfcParameter_ptr ParamBefore)

Reorders the given parameter to come just after the indicated parameter.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - Parameter 'param_before' does not have the same owner as the parameter to be reordered.

pfcXToolkitNoLicense - No license is available for this functionality.

Manual References:: Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options

Parameters:

ParamBefore: The parameter to be just before the reordered parameter. If NULL, the reordered parameter is moved to the first position in the parameter list.

Returns:

optional pfcParameterDriverType GetDriverType ()

Obtains the type of driver for a material parameter.

Manual References:: Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options

Returns:: The parameter driver type.

optional pfcParameterRestriction_ptr GetRestriction ()

Identifies if a parameter's value is restricted to a certain range or enumerated.

Manual References:: Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options

Returns:: The parameter restriction.