CIP C++ documentation for class "wfcWParameter"

Class wfcWParameter

# include <wfcModelItem.h> class wfcWParameter : public virtual pfcParameter { xaideclare(wfcWParameter) ... };

Description

A parameter object. This is an extension of pfcParameter

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes, External Objects: Summary of External Objects

Method Summary


`optional wfcWParameter_ptr`	`GetDrivingParam ()`
	Obtains the driving parameter for a material parameter, if the driver type is pfcPARAMDRIVER_PARAM.

`wfcParamLockstatus`	`GetLockStatus ()`
	Obtains the lock status of the parameter.

`optional wfcParamTableset_ptr`	`GetTableset ()`
	Obtains the parameter table set that this parameter is governed by.

`wfcParamValueWithUnits_ptr`	`GetValueWithUnits ()`
	Obtains the value of the parameter along with units.

`void`	`SetDrivingParam (wfcWParameter_ptr DrivingParam)`
	Assigns the driving parameter for a material parameter. This will set the driver type to be pfcPARAMDRIVER_PARAM.

`void`	`SetLockStatus (wfcParamLockstatus LockStatus)`
	Sets the lock status of the parameter.

`void`	`SetValueWithUnits (wfcParamValueWithUnits_ptr ValueWithUnits)`
	Sets the value of the parameter along with units.

Methods Inherited from Class pfcBaseParameter:: GetValue, SetValue, GetIsDesignated, SetIsDesignated, GetIsRelationDriven, GetIsModified, ResetFromBackup

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcNamedModelItem:: GetName

Methods Inherited from Class pfcParameter:: Delete, GetUnits, GetScaledValue, SetScaledValue, GetDescription, SetDescription, Reorder, GetDriverType, GetRestriction

Method Detail

optional wfcParamTableset_ptr GetTableset ()

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

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - 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

optional wfcWParameter_ptr GetDrivingParam ()

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

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - 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

void SetDrivingParam (wfcWParameter_ptr 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):

pfcXToolkitBadContext - This parameter cannot be driven by another parameter.

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

Parameters:

DrivingParam: The driving parameter

Returns:

wfcParamLockstatus GetLockStatus ()

Obtains the lock status of the parameter.

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

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

void SetLockStatus (wfcParamLockstatus LockStatus)

Sets the lock status of the parameter.

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

Parameters:

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

Returns:

wfcParamValueWithUnits_ptr GetValueWithUnits ()

Obtains the value of the parameter along with units.

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

Returns:: The parameter value and units contained in <reference 1 to unknown entity ParamValueWithUnits>

void SetValueWithUnits (wfcParamValueWithUnits_ptr ValueWithUnits)

Sets the value of the parameter along with units.

For unitless parameters use pfcUnit as NULL in <reference 1 to unknown entity ParamValueWithUnits>

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

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The owner was not found.

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

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

Parameters:

ValueWithUnits

Returns: