org.djunits.unit

Class LengthUnit

java.lang.Object

org.djunits.unit.Unit<U>

org.djunits.unit.LinearUnit<LengthUnit>

org.djunits.unit.LengthUnit

All Implemented Interfaces:

Serializable

public class LengthUnit
extends LinearUnit<LengthUnit>

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

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

$LastChangedDate: 2019-01-18 00:35:01 +0100 (Fri, 18 Jan 2019) $, @version $Revision: 324 $, by $Author: averbraeck $, initial version May 15, 2014

Author:

Alexander Verbraeck

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static LengthUnit	ANGSTROM Angstrom = 10^-10 m.
static LengthUnit	ASTRONOMICAL_UNIT Astronomical Unit = 149,597,870,700 m.
static LengthUnit	ATTOMETER am.
static LengthUnit	CENTIMETER cm.
static LengthUnit	DECIMETER dm.
static LengthUnit	DEKAMETER dam.
static LengthUnit	FEMTOMETER fm.
static LengthUnit	FOOT foot (international) = 0.3048 m = 1/3 yd = 12 inches.
static LengthUnit	HECTOMETER hm.
static LengthUnit	INCH inch (international) = 2.54 cm = 1/36 yd = 1/12 ft.
static LengthUnit	KILOMETER km.
static LengthUnit	LIGHTYEAR Lightyear = 9,460,730,472,580,800 m.
static LengthUnit	MEGAMETER Mm.
static LengthUnit	METER m.
static LengthUnit	MICROMETER µm.
static LengthUnit	MILE mile (international) = 5280 ft = 1760 yd.
static LengthUnit	MILLIMETER mm.
static LengthUnit	NANOMETER nm.
static LengthUnit	NAUTICAL_MILE nautical mile (international) = 1852 m.
static LengthUnit	PARSEC Parsec = 648,000 / PI Pc.
static LengthUnit	PICOMETER pm.
static LengthUnit	SI The SI unit for length is meter.
static LengthUnit	YARD yard (international) = 0.9144 m = 3 ft = 36 in.

Fields inherited from class org.djunits.unit.Unit

STANDARD_UNITS

Constructor Summary

Constructors

Constructor and Description
LengthUnit(String name, String abbreviation, UnitSystem unitSystem, LengthUnit referenceUnit, double scaleFactorToReferenceUnit) Build a user-defined LengthUnit with a conversion factor to another LengthUnit.

Method Summary

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

Methods inherited from class org.djunits.unit.LinearUnit

equals, equalsIgnoreNaming, getScale, getScaleFactor, hashCode

Methods inherited from class org.djunits.unit.Unit

generateHashCode, getAbbreviation, getAbbreviationKey, getAllUnitsOfThisType, getName, getNameKey, getSICoefficients, getUnits, getUnitSystem, isBaseSIUnit, isLocalizable, lookupOrCreateSIUnitWithSICoefficients, lookupOrCreateUnitWithSICoefficients, lookupUnitWithSICoefficients, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SI

public static final LengthUnit SI

The SI unit for length is meter.

ATTOMETER

public static final LengthUnit ATTOMETER

am.

FEMTOMETER

public static final LengthUnit FEMTOMETER

fm.

PICOMETER

public static final LengthUnit PICOMETER

pm.

NANOMETER

public static final LengthUnit NANOMETER

nm.

MICROMETER

public static final LengthUnit MICROMETER

µm.

MILLIMETER

public static final LengthUnit MILLIMETER

mm.

METER

public static final LengthUnit METER

m.

CENTIMETER

public static final LengthUnit CENTIMETER

cm.

DECIMETER

public static final LengthUnit DECIMETER

dm.

DEKAMETER

public static final LengthUnit DEKAMETER

dam.

HECTOMETER

public static final LengthUnit HECTOMETER

hm.

KILOMETER

public static final LengthUnit KILOMETER

km.

MEGAMETER

public static final LengthUnit MEGAMETER

Mm.

INCH

public static final LengthUnit INCH

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

FOOT

public static final LengthUnit FOOT

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

YARD

public static final LengthUnit YARD

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

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.

ASTRONOMICAL_UNIT

public static final LengthUnit ASTRONOMICAL_UNIT

Astronomical Unit = 149,597,870,700 m.

LIGHTYEAR

public static final LengthUnit LIGHTYEAR

Lightyear = 9,460,730,472,580,800 m.

PARSEC

public static final LengthUnit PARSEC

Parsec = 648,000 / PI Pc.

ANGSTROM

public static final LengthUnit ANGSTROM

Angstrom = 10^-10 m.

Constructor Detail

LengthUnit

public LengthUnit(String name,
                  String abbreviation,
                  UnitSystem unitSystem,
                  LengthUnit referenceUnit,
                  double scaleFactorToReferenceUnit)

Build a user-defined LengthUnit with a conversion factor to another LengthUnit.

Parameters:

name - String; the long name of the unit

abbreviation - String; the abbreviation of the unit

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

referenceUnit - LengthUnit; the unit to convert to

scaleFactorToReferenceUnit - double; 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)