Interface IpfcUnit
Description
This class describes a particular unit in the model.
Direct Parent Classes:
User Guide References:
Accessing Individual Units:IpfcUnit, Accessing Systems of Units:IpfcUnit, Conversion to a New Unit System:IpfcUnit, Creating a New System of Units:IpfcUnit, Creating a New Unit:IpfcUnit, Modifying Individual Units:IpfcUnit, Modifying Systems of Units:IpfcUnit, Types of Unit Systems:IpfcUnit
Property Summary
Property | ||
The relationship of the unit to its reference unit. | ||
Property | as String | |
The user-friendly unit description: the name (i.e. "ksi") for ordinary units and the expression (i.e. N/m^3) for system-generated units. | ||
Property | as Boolean | |
Whether the unit is system-defined (value true) or user-defined (value false). | ||
Property | as String | |
Specifies the name of the unit. | ||
Property | as IpfcUnit | |
The reference unit of the unit. | ||
Property | as IpfcUnitType | |
The type of quantity represented by the unit. |
Method Summary
Sub | Delete () |
Delete the unit | |
Sub | |
Modify a unit's definition by applying a new conversion factor and reference unit. |
Property Detail
Property | ConversionFactor |
The relationship of the unit to its reference unit.
Property | Expression | as String |
The user-friendly unit description: the name (i.e. "ksi") for ordinary units and the expression (i.e. N/m^3) for system-generated units.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - The unit type was not recognized.
Property | IsStandard | as Boolean |
Whether the unit is system-defined (value true) or user-defined (value false).
Property | Name | as String |
Specifies the name of the unit.
Exceptions thrown (but not limited to):
IpfcXToolkitCantModify - The unit is referenced from the principal system of units and cannot be modified.
Property | ReferenceUnit | as IpfcUnit |
The reference unit of the unit.
Property | Type | as IpfcUnitType |
The type of quantity represented by the unit.
Method Detail
Sub | Delete | () |
Delete the unit
Exceptions thrown (but not limited to):
IpfcXToolkitCantModify - The unit referenced from another unit or system of units and cannot be deleted.
Sub | Modify |
Modify a unit's definition by applying a new conversion factor and reference unit.
Exceptions thrown (but not limited to):
IpfcXToolkitCantModify - The unit cannot be modified because it is referenced from the principal system of units or it is referenced from ref_unit.
Parameters:
ConversionFactor
The relationship of the unit to its reference unit.
ReferenceUnit
The reference unit.
User Guide References: