Class pfcParameter
Description
This class defines a parameter object.
Direct Parent Classes:
User Guide References:
Accessing User-Defined Material Properties:pfcParameter, Creating and Accessing Parameters:pfcParameter, Enumeration Restriction:pfcParameter, Parameter Information:pfcParameter, Parameter Restrictions:pfcParameter, Parameter Selection Options:pfcParameter, Range Restriction:pfcParameter
Property Summary
/* optional */ string | |
Parameter description string. | |
/* readonly */ /* optional */ pfcUnit | |
Units assigned to the parameter. |
Method Summary
void | Delete () |
Deletes a parameter. | |
/* optional */ pfcParameterDriverType | |
Obtains the type of driver for a material parameter. | |
/* optional */ pfcParameterRestriction | |
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. | |
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. |
Property Detail
/* optional */ string | Description |
Parameter description string.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The parameter's description is not set.
/* readonly */ /* optional */ pfcUnit | Units |
Units assigned to the parameter.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The parameter is unitless.
Method Detail
void | Delete | () |
Deletes a parameter.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The owner was not found.
/* optional */ pfcParameterDriverType | GetDriverType | () |
Obtains the type of driver for a material parameter.
Returns:
The parameter driver type.
User Guide References:
/* optional */ pfcParameterRestriction | GetRestriction | () |
Identifies if a parameter's value is restricted to a certain range or enumerated.
Returns:
The parameter restriction.
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.
Returns:
The parameter scaled value.
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.
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.
User Guide References:
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.
Parameters:
value
The value of the parameter to be set.
Units
The units in which the value is expressed. The value can be null.
User Guide References: