Units of Measure::UnitOfMeasure

: Public abstract Class

Created:	23.5.2022 18.05.04
Modified:	1.8.2022 13.54.02

Project:
Author:	Marko Kauppi
Version:	2005
Phase:	IS
Status:	Superseeded
Complexity:	Easy
Difficulty:
Priority:
Multiplicity:
Advanced:
UUID:	{AB216E33-1DC2-403b-A0C1-9107E9A9F204}
Appears In:	Context Diagram: UomVolume, Context Diagram: UomAngle, Context Diagram: Measure, Context Diagram: UomWeight, Context Diagram: UomScale, Main, Context Diagram: UomArea, Context Diagram: UomCurrency, Context Diagram: UomTime, Context Diagram: UnitOfMeasure, Context Diagram: UomLength, Context Diagram: UomVelocity

Any of the systems devised to measure some physical quantity such distance or area or a system devised to measure such things as the passage of time. The classes of UnitOfMeasure are determined by the member "measureType." Subclasses are not needed for implementation, but their use makes type constraints on measure valued attributes easier to specify. -- conversionToISOstandardUnit is not null only if the conversion is a simple scale

Attributes
Operations
Associations To
Associations From
Tagged Values
Constraints
Advanced
Other Links

Attribute

Public CharacterString
formula

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

Notes:

An algebraic formula (probably in some programming language) converting this unit of measure (represented in the formula by its uomSymbol) to the ISO standard (represented by its symbol. This member attribute is not required, but it is a valuable piece of documentation.

Public MeasureType
measureType

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Public CharacterString
nameStandardUnit

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

Notes:

Name of the standard units to which this unit of measure can be directly converted. If this variable is NULL, then the standard unit for this measure type given by the local copy of the StandardsUnits code list.

Public Real
offsetToStandardUnit

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

Notes:

See scaleToStandardUnit for a description. Again, this variable is NULL is no linear conversion is possible. If the two units are only a scale in difference, then this number is zero (0). If the implementation system used for this object does not support NULL, the then scale set to 0 is equivalent to NULL for both scale and offset.

Public Real
scaleToStandardUnit

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

Notes:

Multiplicative factor for conversion of this unit of measure to the standard one (often the ISO standard unit). This is NULL (or equivalent zero (0)) if the conversion is not simply a linear one. If the implementation system used for this object does not support NULL, the scale set to 0 is equivalent to NULL for both scale and offset. If X is the current unit, and S is the standard one the of two variables scale(ToStandardUnit) and offset(ToStandardUnit) can be used to make the conversion from X to S by: S = offset + scale*X and, conversely, X = (S-offset)/scale

Public CharacterString
uomName

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

The name(s) of a particular unit of measure. Examples would include the following: 1) for uomArea - square feet, 2) for uomTime - seconds, 3)for uomArea - miles and 4) uomAngle - degrees.

Public CharacterString
uomSymbol

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

The symbol used for this unit of measure, such at "ft" for feet, or "m" for meter.

Operation

Public
convertFrom(

m: Measure,

Default:
Kind:	inout
Stereotype:

):Measure

Details:

Sequential

Notes:

Operation to convert from the parameter measure to a measure in this UnitOfMeasure.

Public
convertFromStandard(

m: Measure,

Default:
Kind:	inout
Stereotype:

):Measure

Details:

Sequential

Notes:

Operation to convert from the standard units to a measure in this UnitOfMeasure. A special case of convertFrom, since the Measure m passed as a parameter must carry its UnitOfMeasure.

Public
convertTo(

m: UnitOfMeasure,

Default:
Kind:	inout
Stereotype:

):Measure

Details:

Sequential

Notes:

Operation to convert a Measure in this unit to the one given by the parameter.

Public
convertToStandard(

m: Measure,

Default:
Kind:	inout
Stereotype:

):Measure

Details:

Sequential

Notes:

Operation to convert a Measure in this unit to the standard one given by the nameStandardUnit variable.

Element	Source Role	Target Role
Measure Class	Name: uom The units used by the measure.	Name: measure The measure in question.
Details:
UnitOfMeasure Class	Name:	Name: subunit
Details:

Element	Source Role	Target Role
UnitOfMeasure Class	Name:	Name: subunit
Details:

Tag	Value
persistence	persistent
Details:

Constraint	Type	Status
conversionToISOstandardUnit is not null only of the conversion is a simple	Invariant	Superseeded
Details: conversionToISOstandardUnit is not null only of the conversion is a simple <br/>

Property	Value
isFinalSpecialization:	0

Object	Type	Connection	Direction	Notes
UomTime	Class	Generalization	From
UomArea	Class	Generalization	From
UomCurrency	Class	Generalization	From
«type» UomWeight	Class	Generalization	From
UomVolume	Class	Generalization	From
UnitOfMeasure	Class	Class	To
UomAngle	Class	Generalization	From
UomScale	Class	Generalization	From
UomLength	Class	Generalization	From
UomVelocity	Class	Generalization	From