Class pfcUnitSystem
# include <pfcUnits.h>
class pfcUnitSystem
: public virtual pfcChild
{
xaideclare(pfcUnitSystem)
...
};
Description
This class describes a particular unit system in the model.
User Guide References:
Accessing Systems of Units:pfcUnitSystem, Modifying Systems of Units:pfcUnitSystem, Types of Unit Systems:pfcUnitSystem
Methods Inherited from Class pfcChild::
Method Summary
void | Delete () |
Delete the unit system | |
Specifies whether the unit system is system-defined (value true) or user-defined (value false). | |
GetName () | |
void | |
Specifies the name of the unit system | |
GetType () | |
Specifies the type of the unit system. | |
Retrieves the unit used by the unit system for a particular type. | |
Method Detail
Specifies the name of the unit system
Exceptions thrown (but not limited to):
pfcXToolkitCantModify - The unit system cannot be modified because if is standard, or new_name already exists, or the model cannot be modified.
User Guide References:
GetType | () |
Specifies the type of the unit system.
User Guide References:
GetIsStandard | () |
Specifies whether the unit system is system-defined (value true) or user-defined (value false).
User Guide References:
GetUnit |
Retrieves the unit used by the unit system for a particular type.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - system does not contain a unit of the requested type.
User Guide References:
Parameters:
Type
The type of unit.
Returns:
The unit.
void | Delete | () |
Delete the unit system
Exceptions thrown (but not limited to):
pfcXToolkitCantModify - The unit system cannot be modified because if is standard, or is the principal system, or the model cannot be modified.
User Guide References:
Returns: