Library | Module

Interface IpfcUnit



Description

This class describes a particular unit in the model.
Direct Parent Classes:
IpfcChild



Property Summary

PropertyConversionFactoras IpfcUnitConversionFactor
The relationship of the unit to its reference unit.
PropertyExpressionas 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.
PropertyIsStandardas Boolean
Whether the unit is system-defined (value true) or user-defined (value false).
PropertyNameas String
Specifies the name of the unit.
PropertyReferenceUnitas IpfcUnit
The reference unit of the unit.
PropertyTypeas IpfcUnitType
The type of quantity represented by the unit.



Method Summary

SubDelete ()
Delete the unit
SubModify (ConversionFactor as IpfcUnitConversionFactor, ReferenceUnit as IpfcUnit)
Modify a unit's definition by applying a new conversion factor and reference unit.



Property Detail


PropertyConversionFactoras IpfcUnitConversionFactor

The relationship of the unit to its reference unit.




PropertyExpressionas 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.






PropertyIsStandardas Boolean

Whether the unit is system-defined (value true) or user-defined (value false).




PropertyNameas 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.






PropertyReferenceUnitas IpfcUnit

The reference unit of the unit.




PropertyTypeas IpfcUnitType

The type of quantity represented by the unit.





Method Detail


SubDelete ()

Delete the unit

Exceptions thrown (but not limited to):

IpfcXToolkitCantModify - The unit referenced from another unit or system of units and cannot be deleted.





SubModify (ConversionFactor as IpfcUnitConversionFactor, ReferenceUnit as IpfcUnit)

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.