CIP JavaScript documentation for class " pfcBaseParameter"

Class pfcBaseParameter

Description

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

Direct Parent Classes:: pfcObject

Direct Known Subclasses:: pfcParameter, pfcBaseDimension

Property Summary


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

`/* readonly */ boolean`	`IsModified`
	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.

`/* readonly */ boolean`	`IsRelationDriven`
	Identifies if the dimension or parameter is relation driven.

`pfcParamValue`	`Value`
	The value of the parameter.

Method Summary


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

Property Detail

boolean IsDesignated

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.

/* readonly */ boolean IsModified

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.

/* readonly */ boolean IsRelationDriven

Identifies if the dimension or parameter is relation driven.

pfcParamValue Value

The value of the parameter.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The input dimension is reference.

pfcXToolkitNotFound - The owner was not found.

Method Detail

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.