org.opentrafficsim.core.unit

Class LengthUnit

java.lang.Object

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

org.opentrafficsim.core.unit.LengthUnit

All Implemented Interfaces:

Serializable

public class LengthUnit
extends Unit<LengthUnit>

Standard length units. Several conversion factors have been taken from http://en.wikipedia.org/wiki/Conversion_of_units.

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

Field Summary

Fields

Modifier and Type	Field and Description
static LengthUnit	CENTIMETER centimeter.
static LengthUnit	DECIMETER decimeter.
static LengthUnit	DEKAMETER decameter.
static LengthUnit	FOOT foot (international) = 0.3048 m = 1/3 yd = 12 inches.
static LengthUnit	HECTOMETER hectometer.
static LengthUnit	INCH inch (international) = 2.54 cm = 1/36 yd = 1/12 ft.
static LengthUnit	KILOMETER kilometer.
static LengthUnit	METER meter.
static LengthUnit	MILE mile (international) = 5280 ft = 1760 yd.
static LengthUnit	MILLIMETER millimeter.
static LengthUnit	NAUTICAL_MILE nautical mile (international) = 1852 m.
static LengthUnit	SI The SI unit for length is meter.
static LengthUnit	YARD yard (international) = 0.9144 m = 3 ft = 36 in.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getSICoefficientsString()
LengthUnit	getStandardUnit()

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

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

Methods inherited from class java.lang.Object

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

Field Detail

SI

public static final LengthUnit SI

The SI unit for length is meter.

METER

public static final LengthUnit METER

meter.

MILLIMETER

public static final LengthUnit MILLIMETER

millimeter.

CENTIMETER

public static final LengthUnit CENTIMETER

centimeter.

DECIMETER

public static final LengthUnit DECIMETER

decimeter.

DEKAMETER

public static final LengthUnit DEKAMETER

decameter.

HECTOMETER

public static final LengthUnit HECTOMETER

hectometer.

KILOMETER

public static final LengthUnit KILOMETER

kilometer.

FOOT

public static final LengthUnit FOOT

foot (international) = 0.3048 m = 1/3 yd = 12 inches.

INCH

public static final LengthUnit INCH

inch (international) = 2.54 cm = 1/36 yd = 1/12 ft.

MILE

public static final LengthUnit MILE

mile (international) = 5280 ft = 1760 yd.

NAUTICAL_MILE

public static final LengthUnit NAUTICAL_MILE

nautical mile (international) = 1852 m.

YARD

public static final LengthUnit YARD

yard (international) = 0.9144 m = 3 ft = 36 in.

Constructor Detail

LengthUnit

public LengthUnit(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

LengthUnit

public LengthUnit(String nameKey,
                  String abbreviationKey,
                  UnitSystem unitSystem,
                  LengthUnit referenceUnit,
                  double conversionFactorToReferenceUnit)

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

Method Detail

getStandardUnit

public final LengthUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<LengthUnit>

Returns:

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

getSICoefficientsString

public final String getSICoefficientsString()

Specified by:

getSICoefficientsString in class Unit<LengthUnit>

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)