| Library | Module | Frames | Expand |
| Property | Description | as String [optional] |
| Parameter description string. | ||
| Property | Units | as IpfcUnit [readonly, optional] |
| Units assigned to the parameter. | ||
| Sub | Delete () | |
| Deletes a parameter. | ||
| Function | GetDriverType () as IpfcParameterDriverType [optional] | |
| Obtains the type of driver for a material parameter. | ||
| Function | GetRestriction () as IpfcParameterRestriction [optional] | |
| Identifies if a parameter's value is restricted to a certain range or enumerated. | ||
| Function | GetScaledValue () as IpfcParamValue | |
| Gets the parameter value in the units of the parameter, instead of the units of the owner model. | ||
| Sub | Reorder (ParamBefore as IpfcParameter [optional]) | |
| Reorders the given parameter to come just after the indicated parameter. | ||
| Sub | SetScaledValue (value as IpfcParamValue, Units as IpfcUnit [optional]) | |
| Sets the parameter value in terms of the units provided, instead of using the units of the owner model. | ||
| Property | Description | as String [optional] |
|
Parameter description string. Exceptions thrown (but not limited to): IpfcXToolkitNotFound - The parameter's description is not set. |
| Property | Units | as IpfcUnit [readonly, optional] |
|
Units assigned to the parameter. Exceptions thrown (but not limited to): IpfcXToolkitNotFound - The parameter is unitless. |
| Sub | Delete | () |
|
Deletes a parameter. Exceptions thrown (but not limited to): IpfcXToolkitNotFound - The owner was not found. |
| Function | GetDriverType | () as IpfcParameterDriverType [optional] |
|
Obtains the type of driver for a material parameter.
|
| Function | GetRestriction | () as IpfcParameterRestriction [optional] |
|
Identifies if a parameter's value is restricted to a certain range or enumerated.
|
| Function | GetScaledValue | () as IpfcParamValue |
|
Gets the parameter value in the units of the parameter, instead of the units of the owner model. Exceptions thrown (but not limited to): IpfcXToolkitNotFound - The owner was not found.
|
| Sub | Reorder | (ParamBefore as IpfcParameter [optional]) |
|
Reorders the given parameter to come just after the indicated parameter. Exceptions thrown (but not limited to): IpfcXToolkitBadContext - Parameter 'param_before' does not have the same owner as the parameter to be reordered. IpfcXToolkitNoLicense - No license is available for this functionality.
|
| Sub | SetScaledValue | (value as IpfcParamValue, Units as IpfcUnit [optional]) |
|
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): IpfcXToolkitNotFound - The owner was not found. IpfcXToolkitInvalidType - The unit type provided does not match the units of the parameter.
|