org.djunits.unit

Class PositionUnit

java.lang.Object

org.djunits.unit.Unit<U>

org.djunits.unit.LinearUnit<AU>

org.djunits.unit.AbsoluteLinearUnit<PositionUnit,LengthUnit>

org.djunits.unit.PositionUnit

All Implemented Interfaces:

Serializable, AbsoluteUnit

public class PositionUnit
extends AbsoluteLinearUnit<PositionUnit,LengthUnit>

Standard absolute position units.

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

$LastChangedDate: 2017-04-15 02:11:44 +0200 (Sat, 15 Apr 2017) $, @version $Revision: 239 $, 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 PositionUnit	ANGSTROM Positions scaled to Angstrom = 10^-10 m.
static PositionUnit	ASTRONOMICAL_UNIT Positions scaled to Astronomical Unit = 149,597,870,700 m.
static PositionUnit	ATTOMETER Positions scaled to am.
static PositionUnit	BASE The BASE unit for position with an artificial zero-point.
static PositionUnit	CENTIMETER Positions scaled to cm.
static PositionUnit	DECIMETER Positions scaled to dm.
static PositionUnit	DEKAMETER Positions scaled to dam.
static PositionUnit	FEMTOMETER Positions scaled to fm.
static PositionUnit	FOOT Positions scaled to foot (international) = 0.3048 m = 1/3 yd = 12 inches.
static PositionUnit	HECTOMETER Positions scaled to hm.
static PositionUnit	INCH Positions scaled to inch (international) = 2.54 cm = 1/36 yd = 1/12 ft.
static PositionUnit	KILOMETER Positions scaled to km.
static PositionUnit	LIGHTYEAR Positions scaled to Lightyear = 9,460,730,472,580,800 m.
static PositionUnit	MEGAMETER Positions scaled to Mm.
static PositionUnit	METER Positions scaled to m.
static PositionUnit	MICROMETER Positions scaled to µm.
static PositionUnit	MILE Positions scaled to mile (international) = 5280 ft = 1760 yd.
static PositionUnit	MILLIMETER Positions scaled to mm.
static PositionUnit	NANOMETER Positions scaled to nm.
static PositionUnit	NAUTICAL_MILE Positions scaled to nautical mile (international) = 1852 m.
static PositionUnit	PARSEC Positions scaled to Parsec = 648,000 / PI Pc.
static PositionUnit	PICOMETER Positions scaled to pm.
static PositionUnit	YARD Positions scaled to 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
PositionUnit(String name, String abbreviation, UnitSystem unitSystem, double scaleFactor, double offset, LengthUnit relativeUnit) Build a user-defined PositionUnit with a scale factor and offset to the base PositionUnit.

Method Summary

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

Methods inherited from class org.djunits.unit.AbsoluteLinearUnit

equals, equalsIgnoreNaming, getOffset, getRelativeUnit, getScale, hashCode

Methods inherited from class org.djunits.unit.LinearUnit

getScaleFactor

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

Methods inherited from interface org.djunits.unit.AbsoluteUnit

getScaleFactor

Field Detail

BASE

public static final PositionUnit BASE

The BASE unit for position with an artificial zero-point.

ATTOMETER

public static final PositionUnit ATTOMETER

Positions scaled to am.

FEMTOMETER

public static final PositionUnit FEMTOMETER

Positions scaled to fm.

PICOMETER

public static final PositionUnit PICOMETER

Positions scaled to pm.

NANOMETER

public static final PositionUnit NANOMETER

Positions scaled to nm.

MICROMETER

public static final PositionUnit MICROMETER

Positions scaled to µm.

MILLIMETER

public static final PositionUnit MILLIMETER

Positions scaled to mm.

METER

public static final PositionUnit METER

Positions scaled to m.

CENTIMETER

public static final PositionUnit CENTIMETER

Positions scaled to cm.

DECIMETER

public static final PositionUnit DECIMETER

Positions scaled to dm.

DEKAMETER

public static final PositionUnit DEKAMETER

Positions scaled to dam.

HECTOMETER

public static final PositionUnit HECTOMETER

Positions scaled to hm.

KILOMETER

public static final PositionUnit KILOMETER

Positions scaled to km.

MEGAMETER

public static final PositionUnit MEGAMETER

Positions scaled to Mm.

INCH

public static final PositionUnit INCH

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

FOOT

public static final PositionUnit FOOT

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

YARD

public static final PositionUnit YARD

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

MILE

public static final PositionUnit MILE

Positions scaled to mile (international) = 5280 ft = 1760 yd.

NAUTICAL_MILE

public static final PositionUnit NAUTICAL_MILE

Positions scaled to nautical mile (international) = 1852 m.

ASTRONOMICAL_UNIT

public static final PositionUnit ASTRONOMICAL_UNIT

Positions scaled to Astronomical Unit = 149,597,870,700 m.

LIGHTYEAR

public static final PositionUnit LIGHTYEAR

Positions scaled to Lightyear = 9,460,730,472,580,800 m.

PARSEC

public static final PositionUnit PARSEC

Positions scaled to Parsec = 648,000 / PI Pc.

ANGSTROM

public static final PositionUnit ANGSTROM

Positions scaled to Angstrom = 10^-10 m.

Constructor Detail

PositionUnit

public PositionUnit(String name,
                    String abbreviation,
                    UnitSystem unitSystem,
                    double scaleFactor,
                    double offset,
                    LengthUnit relativeUnit)

Build a user-defined PositionUnit with a scale factor and offset to the base PositionUnit.

Parameters:

name - the long name of the unit

abbreviation - the abbreviation of the unit

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

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

offset - the offset to the reference unit to add to convert to the standard (e.g., BASE) unit

relativeUnit - the corresponding relative unit belonging to this absolute unit

Method Detail

getStandardUnit

public final PositionUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<PositionUnit>

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<PositionUnit>

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)