CIP C++ documentation for class "pfcBaseParameter"

Class pfcBaseParameter

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

Description

Describes the base parameter, which can be a Creo Parametric parameter or dimension.

Manual References:: Dimensions and Parameters: Overview, Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Dimension Information

Direct Known Subclasses:: pfcParameter, pfcBaseDimension

Method Summary


`xbool`	`GetIsDesignated ()`
`void`	`SetIsDesignated (xbool value)`
	If this is `true`, the parameter is designated for use with Windchill.

`xbool`	`GetIsModified ()`
	If this is `true`, the parameter is modified. A parameter is said to be "modified" when it has been changed, but the parameter's owner has not yet been regenerated.

`xbool`	`GetIsRelationDriven ()`
	Identifies if the dimension or parameter is relation driven.

`pfcParamValue_ptr`	`GetValue ()`
`void`	`SetValue (pfcParamValue_ptr value)`
	The value of the parameter.

`void`	`ResetFromBackup ()`
	Resets the parameter to the value it had before it was last set in the current Creo Parametric.

Method Detail

`pfcParamValue_ptr`	`GetValue`	`()`
`void`	`SetValue`	`(pfcParamValue_ptr value)`

The value of the parameter.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The input dimension is reference.

pfcXToolkitNotFound - The owner was not found.

Manual References:: Dimensions and Parameters: Accessing a ParamValue Object, Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Dimension Information

`xbool`	`GetIsDesignated`	`()`
`void`	`SetIsDesignated`	`(xbool value)`

If this is true, the parameter is designated for use with Windchill.

Exceptions thrown (but not limited to):

pfcXToolkitFound - The specified parameter already exists.

pfcXToolkitNotFound - The specified parameter was not found.

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

xbool GetIsRelationDriven ()

Identifies if the dimension or parameter is relation driven.

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

xbool GetIsModified ()

If this is true, the parameter is modified. A parameter is said to be "modified" when it has been changed, but the parameter's owner has not yet been regenerated.

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, Dimensions and Parameters: Dimension Information

void ResetFromBackup ()

Resets the parameter to the value it had before it was last set in the current Creo Parametric.

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, Dimensions and Parameters: Dimension Information

Returns: