CIP JAVA documentation for class "com.ptc.pfc.pfcModelItem.BaseParameter"

Interface BaseParameter

package com.ptc.pfc.pfcModelItem; public interface BaseParameter extends com.ptc.pfc.pfcObject.Object

Description

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

Direct Known Subclasses:: Parameter, BaseDimension

Method Summary
`boolean`	`GetIsDesignated ()` Get method for attribute "IsDesignated" If this is `true`, the parameter is designated for use with Windchill.
`boolean`	`GetIsModified ()` Get method for attribute "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.
`boolean`	`GetIsRelationDriven ()` Get method for attribute "IsRelationDriven" Identifies if the dimension or parameter is relation driven.
`ParamValue`	`GetValue ()` Get method for attribute "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.
`void`	`SetIsDesignated (boolean value)` Set method for attribute "IsDesignated" If this is `true`, the parameter is designated for use with Windchill.
`void`	`SetValue (ParamValue value)` Set method for attribute "Value" The value of the parameter.

Method Detail

GetValue/SetValue

`ParamValue`	`GetValue`	`()`
`void`	`SetValue`	`(ParamValue value)`

The value of the parameter.

Exceptions thrown (but not limited to):

XToolkitBadContext - The input dimension is reference.

XToolkitNotFound - The owner was not found.

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

GetIsDesignated/SetIsDesignated

`boolean`	`GetIsDesignated`	`()`
`void`	`SetIsDesignated`	`(boolean value)`

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

Exceptions thrown (but not limited to):

XToolkitFound - The specified parameter already exists.

XToolkitNotFound - The specified parameter was not found.

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

GetIsRelationDriven

boolean GetIsRelationDriven ()

Identifies if the dimension or parameter is relation driven.

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

GetIsModified

boolean 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):

XToolkitNotFound - The owner was not found.

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

ResetFromBackup

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):

XToolkitNotFound - The owner was not found.

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

Returns: