Class pfcParameter
# include <pfcModelItem.h>
class pfcParameter
: public virtual pfcBaseParameter,
: public virtual pfcNamedModelItem
{
xaideclare(pfcParameter)
...
};
Description
This class defines a parameter object.
User Guide References:
Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes:pfcParameter, Creo-Related Interfaces:pfcParameter, Creating and Accessing Parameters:pfcParameter, Parameter Selection Options:pfcParameter, Parameter Information:pfcParameter, Parameter Restrictions:pfcParameter, Enumeration Restriction:pfcParameter, Range Restriction:pfcParameter, Table Parameters:pfcParameter, Driven and Driving Parameters:pfcParameter, Accessing Columns:pfcParameter
Direct Known Subclasses:
Methods Inherited from Class pfcBaseParameter::
GetValue, SetValue, GetIsDesignated, SetIsDesignated, GetIsRelationDriven, GetIsModified, ResetFromBackup
Methods Inherited from Class pfcChild::
Methods Inherited from Class pfcNamedModelItem::
Method Summary
void | Delete () |
Deletes a parameter. | |
void | |
Parameter description string. | |
Obtains the type of driver for a material parameter. | |
Identifies if a parameter's value is restricted to a certain range or enumerated. | |
Gets the parameter value in the units of the parameter, instead of the units of the owner model. | |
GetUnits () | |
Units assigned to the parameter. | |
void | |
Reorders the given parameter to come just after the indicated parameter. | |
void | |
Sets the parameter value in terms of the units provided, instead of using the units of the owner model. |
Method Detail
void | Delete | () |
Deletes a parameter.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The owner was not found.
User Guide References:
Returns:
GetUnits | () |
Units assigned to the parameter.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The parameter is unitless.
User Guide References:
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):
pfcXToolkitNotFound - The owner was not found.
User Guide References:
Returns:
The parameter scaled value.
void | SetScaledValue |
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):
pfcXToolkitNotFound - The owner was not found.
pfcXToolkitInvalidType - The unit type provided does not match the units of the parameter.
User Guide References:
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 | () | |
void | SetDescription |
Parameter description string.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The parameter's description is not set.
User Guide References:
void | Reorder |
Reorders the given parameter to come just after the indicated parameter.
Exceptions thrown (but not limited to):
pfcXToolkitBadContext - Parameter 'param_before' does not have the same owner as the parameter to be reordered.
pfcXToolkitNoLicense - No license is available for this functionality.
User Guide References:
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 | () |
Obtains the type of driver for a material parameter.
User Guide References:
Returns:
The parameter driver type.
GetRestriction | () |
Identifies if a parameter's value is restricted to a certain range or enumerated.
User Guide References:
Returns:
The parameter restriction.