Class wfcWParameter
# include <wfcModelItem.h>
class wfcWParameter
: public virtual pfcParameter
{
xaideclare(wfcWParameter)
...
};
Description
A parameter object. This is an extension of pfcParameter
User Guide References:
Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes:wfcWParameter, Creating and Accessing Parameters:wfcWParameter, Driven and Driving Parameters:wfcWParameter, External Objects:wfcWParameter, Parameter Information:wfcWParameter, Table Parameters:wfcWParameter
Methods Inherited from Class pfcBaseParameter::
GetValue, SetValue, GetIsDesignated, SetIsDesignated, GetIsRelationDriven, GetIsModified, ResetFromBackup
Methods Inherited from Class pfcChild::
Methods Inherited from Class pfcNamedModelItem::
Methods Inherited from Class pfcParameter::
Delete, GetUnits, GetScaledValue, SetScaledValue, GetDescription, SetDescription, Reorder, GetDriverType, GetRestriction
Method Summary
Obtains the driving parameter for a material parameter, if the driver type is pfcPARAMDRIVER_PARAM. | |
Obtains the lock status of the parameter. | |
GetTableset () | |
Obtains the parameter table set that this parameter is governed by. | |
Obtains the value of the parameter along with units. | |
void | |
Assigns the driving parameter for a material parameter. This will set the driver type to be pfcPARAMDRIVER_PARAM. | |
void | |
Sets the lock status of the parameter. | |
void | |
Sets the value of the parameter along with units. |
Method Detail
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.
User Guide References:
Returns:
The parameter table set
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'.
User Guide References:
Returns:
The driving parameter
void | SetDrivingParam |
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.
User Guide References:
Parameters:
DrivingParam
The driving parameter
Returns:
GetLockStatus | () |
Obtains the lock status of the parameter.
User Guide References:
Returns:
The parameter lock status <reference 1 to unknown entity ParamLockstatus>
void | SetLockStatus |
Sets the lock status of the parameter.
User Guide References:
Parameters:
LockStatus
The parameter lock status <reference 1 to unknown entity ParamLockstatus>
Returns:
GetValueWithUnits | () |
Obtains the value of the parameter along with units.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The owner was not found.
User Guide References:
Returns:
The parameter value and units contained in <reference 1 to unknown entity ParamValueWithUnits>
void | SetValueWithUnits |
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.
User Guide References:
Parameters:
ValueWithUnits
Returns: