org.opentrafficsim.core.unit

Class OffsetUnit<U extends Unit<U>>

java.lang.Object

org.opentrafficsim.core.unit.Unit<U>

org.opentrafficsim.core.unit.OffsetUnit<U>

Type Parameters:

U - the unit type

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TemperatureUnit

public abstract class OffsetUnit<U extends Unit<U>>
extends Unit<U>

The OffsetUnit provides a unit where scales can have an offset, such as the temperature scale. Internally, all units are internally stored as a standard unit with an offset and a conversion factor. This means that e.g., Kelvin is stored with offset 0.0 and conversion factor 1.0, whereas degree Celsius is stored with offset -273.15 and conversion factor 1.0. This means that if we have a Temperature, it is stored in Kelvins, and if we want to display it in degree Celsius, we have to divide by the conversion factor and subtract the offset.

Copyright (c) 2014 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

Jun 5, 2014

Author:

Alexander Verbraeck

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OffsetUnit(String nameKey, String abbreviationKey, UnitSystem unitSystem) Build a standard unit.
OffsetUnit(String nameKey, String abbreviationKey, UnitSystem unitSystem, U referenceUnit, double conversionFactorToReferenceUnit, double offsetToStandardUnit) Build an offset unit with a conversion factor and offset to another unit.

Method Summary

Methods

Modifier and Type	Method and Description
double	getOffsetToStandardUnit()

Methods inherited from class org.opentrafficsim.core.unit.Unit

getAbbreviation, getAbbreviationKey, getAllUnitsOfThisType, getConversionFactorToStandardUnit, getName, getNameKey, getSICoefficients, getSICoefficientsString, getStandardUnit, getUnits, getUnitSystem, lookupOrCreateSIUnitWithSICoefficients, lookupOrCreateUnitWithSICoefficients, lookupUnitWithSICoefficients, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OffsetUnit

public OffsetUnit(String nameKey,
          String abbreviationKey,
          UnitSystem unitSystem)

Build a standard unit.

Parameters:

nameKey - the key to the locale file for the long name of the unit

abbreviationKey - the key to the locale file for the abbreviation of the unit

unitSystem - the unit system, e.g. SI or Imperial

OffsetUnit

public OffsetUnit(String nameKey,
          String abbreviationKey,
          UnitSystem unitSystem,
          U referenceUnit,
          double conversionFactorToReferenceUnit,
          double offsetToStandardUnit)

Build an offset unit with a conversion factor and offset to another unit.

Parameters:

nameKey - the key to the locale file for the long name of the unit

abbreviationKey - the key to the locale file for the abbreviation of the unit

unitSystem - the unit system, e.g. SI or Imperial

referenceUnit - the unit to convert to

conversionFactorToReferenceUnit - multiply a value in this unit by the factor to convert to the given reference unit

offsetToStandardUnit - the offset to add to convert to the standard (e.g., SI) unit

Method Detail

getOffsetToStandardUnit

public final double getOffsetToStandardUnit()

Returns:

offset to the standard unit. E.g., -273.15 to go from degrees Celsius to Kelvin