org.djunits.unit

Class DirectionUnit

java.lang.Object

org.djunits.unit.Unit<U>

org.djunits.unit.LinearUnit<AU>

org.djunits.unit.AbsoluteLinearUnit<DirectionUnit,AngleUnit>

org.djunits.unit.DirectionUnit

All Implemented Interfaces:

Serializable, AbsoluteUnit

public class DirectionUnit
extends AbsoluteLinearUnit<DirectionUnit,AngleUnit>

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

Note that the EAST and NORTH Directions are counterclockwise.

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: 2017-01-30 14:23:11 +0100 (Mon, 30 Jan 2017) $, @version $Revision: 234 $, 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 DirectionUnit	BASE The BASE unit for direction with an artificial origin.
static DirectionUnit	EAST_DEGREE The unit for direction with East as the origin and degrees as the displacement.
static DirectionUnit	EAST_RADIAN The unit for direction with East as the origin and radians as the displacement.
static DirectionUnit	NORTH_DEGREE The unit for direction with North as the origin and degrees as the displacement.
static DirectionUnit	NORTH_RADIAN The unit for direction with North as the origin and radians as the displacement.

Fields inherited from class org.djunits.unit.Unit

STANDARD_UNITS

Constructor Summary

Constructors

Constructor and Description
DirectionUnit(String name, String abbreviation, UnitSystem unitSystem, double scaleFactor, double offset, AngleUnit relativeUnit) Build a user-defined DirectionUnit with a scale factor and offset to the base DirectionUnit.

Method Summary

Modifier and Type	Method and Description
String	getSICoefficientsString()
DirectionUnit	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, getDefaultLocaleAbbreviation, getDefaultLocaleName, getDefaultLocaleTextualRepresentation, getDefaultLocaleTextualRepresentations, getDefaultTextualRepresentation, getName, getSICoefficients, getTextualRepresentations, 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 DirectionUnit BASE

The BASE unit for direction with an artificial origin.

EAST_RADIAN

public static final DirectionUnit EAST_RADIAN

The unit for direction with East as the origin and radians as the displacement.

EAST_DEGREE

public static final DirectionUnit EAST_DEGREE

The unit for direction with East as the origin and degrees as the displacement.

NORTH_RADIAN

public static final DirectionUnit NORTH_RADIAN

The unit for direction with North as the origin and radians as the displacement.

NORTH_DEGREE

public static final DirectionUnit NORTH_DEGREE

The unit for direction with North as the origin and degrees as the displacement.

Constructor Detail

DirectionUnit

public DirectionUnit(String name,
                     String abbreviation,
                     UnitSystem unitSystem,
                     double scaleFactor,
                     double offset,
                     AngleUnit relativeUnit)

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

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

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

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

relativeUnit - AngleUnit; the corresponding relative unit belonging to this absolute unit

Method Detail

getStandardUnit

public final DirectionUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<DirectionUnit>

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

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)