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

Interface Parameter

package com.ptc.pfc.pfcModelItem; public interface Parameter extends com.ptc.pfc.pfcModelItem.BaseParameter, com.ptc.pfc.pfcModelItem.NamedModelItem

Description

This class defines a parameter object.

Direct Known Subclasses:: WParameter

Method Summary
`void`	`Delete ()` Deletes a parameter.
`/optional/ String`	`GetDescription ()` Get method for attribute "Description" Parameter description string.
`/optional/ ParameterDriverType`	`GetDriverType ()` Obtains the type of driver for a material parameter.
`/optional/ ParameterRestriction`	`GetRestriction ()` Identifies if a parameter's value is restricted to a certain range or enumerated.
`ParamValue`	`GetScaledValue ()` Gets the parameter value in the units of the parameter, instead of the units of the owner model.
`/optional/ Unit`	`GetUnits ()` Get method for attribute "Units" Units assigned to the parameter.
`void`	`Reorder ( /optional/ Parameter ParamBefore)` Reorders the given parameter to come just after the indicated parameter.
`void`	`SetDescription ( /optional/ String value)` Set method for attribute "Description" Parameter description string.
`void`	`SetScaledValue (ParamValue value, /optional/ Unit Units)` Sets the parameter value in terms of the units provided, instead of using the units of the owner model.

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.BaseParameter`
`GetValue`, `SetValue`, `GetIsDesignated`, `SetIsDesignated`, `GetIsRelationDriven`, `GetIsModified`, `ResetFromBackup`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.NamedModelItem`
`GetName`

Method Detail

Delete

void Delete ()

Deletes a parameter.

Exceptions thrown (but not limited to):

XToolkitNotFound - The owner was not found.

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

Returns:

GetUnits

/*optional*/ Unit GetUnits ()

Units assigned to the parameter.

Exceptions thrown (but not limited to):

XToolkitNotFound - The parameter is unitless.

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

GetScaledValue

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

XToolkitNotFound - The owner was not found.

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

Returns:: The parameter scaled value.

SetScaledValue

void SetScaledValue (ParamValue value, /*optional*/ Unit 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):

XToolkitNotFound - The owner was not found.

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

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

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:

GetDescription/SetDescription

`/optional/ String`	`GetDescription`	`()`
`void`	`SetDescription`	`( /optional/ String value)`

Parameter description string.

Exceptions thrown (but not limited to):

XToolkitNotFound - The parameter's description is not set.

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

Reorder

void Reorder ( /*optional*/ Parameter ParamBefore)

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

Exceptions thrown (but not limited to):

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

XToolkitNoLicense - No license is available for this functionality.

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

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:

GetDriverType

/*optional*/ ParameterDriverType GetDriverType ()

Obtains the type of driver for a material parameter.

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

Returns:: The parameter driver type.

GetRestriction

/*optional*/ ParameterRestriction GetRestriction ()

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

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

Returns:: The parameter restriction.