org.opentrafficsim.core.unit

Class Unit<U extends Unit<U>>

java.lang.Object

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

Type Parameters:

U - the unit for transformation reasons

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AccelerationUnit, AnglePlaneUnit, AngleSlopeUnit, AngleSolidUnit, AreaUnit, DensityUnit, ElectricalChargeUnit, ElectricalCurrentUnit, ElectricalPotentialUnit, ElectricalResistanceUnit, EnergyUnit, FlowMassUnit, FlowVolumeUnit, ForceUnit, FrequencyUnit, LengthUnit, LinearDensityUnit, MassUnit, OffsetUnit, PowerUnit, PressureUnit, SIUnit, SpeedUnit, TimeUnit, TorqueUnit, VolumeUnit

public abstract class Unit<U extends Unit<U>>
extends Object
implements Serializable

All units are internally stored relative to a standard unit with conversion factor. This means that e.g., a meter is stored with conversion factor 1.0, whereas kilometer is stored with a conversion factor 1000.0. This means that if we want to display a meter as kilometers, we have to divide by the conversion factor.

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:

May 15, 2014

Author:

Alexander Verbraeck

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Unit(String nameKey, String abbreviationKey, UnitSystem unitSystem, boolean safe) Build a standard unit.
Unit(String nameKey, String abbreviationKey, UnitSystem unitSystem, U referenceUnit, double conversionFactorToReferenceUnit, boolean safe) Build a unit with a conversion factor to another unit.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAbbreviation()
String	getAbbreviationKey()
Set<Unit<U>>	getAllUnitsOfThisType() Return a copy of the set of all defined units for this unit type.
double	getConversionFactorToStandardUnit()
String	getName()
String	getNameKey()
SICoefficients	getSICoefficients()
abstract String	getSICoefficientsString()
abstract U	getStandardUnit()
static <V extends Unit<V>> Set<V>	getUnits(Class<V> unitClass) Return a set of defined units for a given unit type.
UnitSystem	getUnitSystem()
static SIUnit	lookupOrCreateSIUnitWithSICoefficients(String normalizedSICoefficientsString)
static Set<Unit<?>>	lookupOrCreateUnitWithSICoefficients(String normalizedSICoefficientsString)
static Set<Unit<?>>	lookupUnitWithSICoefficients(String normalizedSICoefficientsString)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Unit

public Unit(String nameKey,
    String abbreviationKey,
    UnitSystem unitSystem,
    boolean safe)

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

safe - Boolean; if true, a UnitException is silently ignored; if false a UnitException is an Error

Unit

public Unit(String nameKey,
    String abbreviationKey,
    UnitSystem unitSystem,
    U referenceUnit,
    double conversionFactorToReferenceUnit,
    boolean safe)

Build a unit with a conversion factor 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

safe - Boolean; if true, a UnitException is silently ignored; if false a UnitException is an Error

Method Detail

getUnits

public static <V extends Unit<V>> Set<V> getUnits(Class<V> unitClass)

Return a set of defined units for a given unit type.

Type Parameters:

V - the unit type to use in this method.

Parameters:

unitClass - the class for which the units are requested, e.g. ForceUnit.class

Returns:

the set of defined units belonging to the provided class. The empty set will be returned in case the unit type does not have any units.

getAllUnitsOfThisType

public final Set<Unit<U>> getAllUnitsOfThisType()

Return a copy of the set of all defined units for this unit type.

Returns:

the set of defined units belonging to this Unit class. The empty set will be returned in case the unit type does not have any units.

getName

public final String getName()

Returns:

name, e.g. meters per second

getNameKey

public final String getNameKey()

Returns:

name key, e.g. TimeUnit.MetersPerSecond

getAbbreviation

public final String getAbbreviation()

Returns:

abbreviation, e.g., m/s

getAbbreviationKey

public final String getAbbreviationKey()

Returns:

abbreviation key, e.g. TimeUnit.m/s

getConversionFactorToStandardUnit

public final double getConversionFactorToStandardUnit()

Returns:

conversionFactorToStandardUnit. Multiply by this number to convert to the standard (e.g., SI) unit

getUnitSystem

public final UnitSystem getUnitSystem()

Returns:

unitSystem, e.g. SI or Imperial

getStandardUnit

public abstract U getStandardUnit()

Returns:

the SI standard unit for this unit, or the de facto standard unit if SI is not available

getSICoefficientsString

public abstract String getSICoefficientsString()

Returns:

the SI standard coefficients for this unit, e.g., kgm/s2 or m-2s2A or m^-2.s^2.A or m^-2s^2A (not necessarily normalized)

getSICoefficients

public final SICoefficients getSICoefficients()

Returns:

the SI coefficients

lookupUnitWithSICoefficients

public static Set<Unit<?>> lookupUnitWithSICoefficients(String normalizedSICoefficientsString)

Parameters:

normalizedSICoefficientsString - the normalized string (e.g., kg.m/s2) to look up

Returns:

a set with the Units belonging to this string, or an empty set when it does not exist

lookupOrCreateUnitWithSICoefficients

public static Set<Unit<?>> lookupOrCreateUnitWithSICoefficients(String normalizedSICoefficientsString)

Parameters:

normalizedSICoefficientsString - the normalized string (e.g., kg.m/s2) to look up

Returns:

a set of Units belonging to this string, or a set with a new unit when it does not yet exist

lookupOrCreateSIUnitWithSICoefficients

public static SIUnit lookupOrCreateSIUnitWithSICoefficients(String normalizedSICoefficientsString)

Parameters:

normalizedSICoefficientsString - the normalized string (e.g., kg.m/s2) to look up

Returns:

the Unit belonging to this string, or a new unit when it does not yet exist

toString

public final String toString()

Overrides:

toString in class Object