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:
Parameters:wfcWParameter, Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes:wfcWParameter, External Objects:wfcWParameter, Creating and Accessing Parameters:wfcWParameter, Parameter Information:wfcWParameter, Table Parameters:wfcWParameter, Driven and Driving 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
void | |
Sets the units assigned to a parameter. | |
Obtains the driving parameter for a material parameter, if the driver type is pfcPARAMDRIVER_PARAM. | |
GetListValue () | |
Retrieves the list values of the specified ProParametere. | |
Retrieves the list values units of the specified ProParametere. | |
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. | |
IsInactive () | |
Determines whether the parameter is inactive. | |
IsListValue () | |
Get whether parameter value type is list or not. | |
void | |
Assigns the driving parameter for a material parameter. This will set the driver type to be pfcPARAMDRIVER_PARAM. | |
void | |
Set a parameter as enumerated, and provides the values that to be assigned to it. | |
void | |
Set parameter value type as list. | |
void | |
Sets the list values given with unit of an existing ProParameter. | |
void | |
Sets the lock status of the parameter. | |
void | SetRange (pfcParameterLimitType minType, pfcParamValue_ptr minValue, pfcParameterLimitType maxType, pfcParamValue_ptr maxValue, pfcParamValue_ptr defaultValue) |
Set parameter's value to be restricted to a certain range. | |
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:
void | SetRange | (pfcParameterLimitType minType, pfcParamValue_ptr minValue, pfcParameterLimitType maxType, pfcParamValue_ptr maxValue, pfcParamValue_ptr defaultValue) |
Set parameter's value to be restricted to a certain range.
The enum pfcParameterLimitType for minimum value The minimum pfcParamValue The enum pfcParameterLimitType for maximum value The maximum pfcParamValue The default pfcParamValue for the parameter.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The owner was not found.
Parameters:
minType
minValue
maxType
maxValue
defaultValue
Returns:
User Guide References:
void | SetEnumerated |
Set a parameter as enumerated, and provides the values that to be assigned to it.
The array of pfcParamValue that should be assigned to this parameter. The default pfcParamValue for the parameter.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The owner was not found.
Parameters:
PermittedValues
defaultValue
Returns:
User Guide References:
GetListValue | () |
Retrieves the list values of the specified ProParametere.
Returns pfcParamValues
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The owner was not found.
Returns:
User Guide References:
GetListValueUnit | () |
Retrieves the list values units of the specified ProParametere.
Returns pfcUnit
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The owner was not found.
Returns:
User Guide References:
void | SetListValue |
Sets the list values given with unit of an existing ProParameter.
The param values pfcParamValues This is optional arg pfcUnits if it is not specified then it considers owner unit.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The owner was not found.
Parameters:
ParamValues
Units
Returns:
User Guide References:
IsListValue | () |
Get whether parameter value type is list or not.
Returns true if parametr is of list values type otherwise false.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The owner was not found.
Returns:
User Guide References:
void | SetListType |
Set parameter value type as list.
True if the specified parameter value type wants to set as list. Falsie if the specified parameter value type wants to set as non-list.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The owner was not found.
Parameters:
IsList
Returns:
User Guide References:
IsInactive | () |
Determines whether the parameter is inactive.
Returns true if parameter is inactive due to current customization of symbol.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The owner was not found.
Returns:
User Guide References:
void | AssignUnits |
Sets the units assigned to a parameter.
pfcUnits assigned to a parameter.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The parameter is unitless.
Parameters:
Units
Returns:
User Guide References: