CIP JAVA documentation for class "com.ptc.wfc.wfcModelItem.WParameter"

Interface WParameter

package com.ptc.wfc.wfcModelItem; public interface WParameter extends com.ptc.pfc.pfcModelItem.Parameter

Description

A parameter object. This is an extension of Parameter

Method Summary
`/optional/ WParameter`	`GetDrivingParam ()` Obtains the driving parameter for a material parameter, if the driver type is pfcPARAMDRIVER_PARAM.
`ParamLockstatus`	`GetLockStatus ()` Obtains the lock status of the parameter.
`/optional/ ParamTableset`	`GetTableset ()` Obtains the parameter table set that this parameter is governed by.
`ParamValueWithUnits`	`GetValueWithUnits ()` Obtains the value of the parameter along with units.
`void`	`SetDrivingParam (WParameter DrivingParam)` Assigns the driving parameter for a material parameter. This will set the driver type to be pfcPARAMDRIVER_PARAM.
`void`	`SetLockStatus (ParamLockstatus LockStatus)` Sets the lock status of the parameter.
`void`	`SetValueWithUnits (ParamValueWithUnits ValueWithUnits)` Sets the value of the parameter along with units.

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`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.Parameter`
`Delete`, `GetUnits`, `GetScaledValue`, `SetScaledValue`, `GetDescription`, `SetDescription`, `Reorder`, `GetDriverType`, `GetRestriction`

Method Detail

GetTableset

/*optional*/ ParamTableset GetTableset ()

Obtains the parameter table set that this parameter is governed by.

Exceptions thrown (but not limited to):

XToolkitNotFound - The parameter is not governed by a parameter table set.

Manual References:: Dimensions and Parameters: Table Parameters, Dimensions and Parameters: Table Parameters

Returns:: The parameter table set

GetDrivingParam

/*optional*/ WParameter GetDrivingParam ()

Obtains the driving parameter for a material parameter, if the driver type is pfcPARAMDRIVER_PARAM.

Exceptions thrown (but not limited to):

XToolkitNotFound - The driver type is not 'parameter'.

Manual References:: Dimensions and Parameters: Driven and Driving Parameters, Dimensions and Parameters: Driven and Driving Parameters

Returns:: The driving parameter

SetDrivingParam

void SetDrivingParam (WParameter DrivingParam)

Assigns the driving parameter for a material parameter. This will set the driver type to be pfcPARAMDRIVER_PARAM.

Exceptions thrown (but not limited to):

XToolkitBadContext - This parameter cannot be driven by another parameter.

Manual References:: Dimensions and Parameters: Driven and Driving Parameters

Parameters:

DrivingParam: The driving parameter

Returns:

GetLockStatus

ParamLockstatus GetLockStatus ()

Obtains the lock status of the parameter.

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

Returns:: The parameter lock status <reference 3 to unknown entity ParamLockstatus>

SetLockStatus

void SetLockStatus (ParamLockstatus LockStatus)

Sets the lock status of the parameter.

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

Parameters:

LockStatus: The parameter lock status <reference 3 to unknown entity ParamLockstatus>

Returns:

GetValueWithUnits

ParamValueWithUnits GetValueWithUnits ()

Obtains the value of the parameter along with units.

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 value and units contained in <reference 3 to unknown entity ParamValueWithUnits>

SetValueWithUnits

void SetValueWithUnits (ParamValueWithUnits ValueWithUnits)

Sets the value of the parameter along with units.

For unitless parameters use Unit as NULL in <reference 3 to unknown entity ParamValueWithUnits>

The parameter value and units contained in <reference 3 to unknown entity ParamValueWithUnits>

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:

ValueWithUnits

Returns: