org.opentrafficsim.core.unit

Class SpeedUnit

java.lang.Object

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

org.opentrafficsim.core.unit.SpeedUnit

All Implemented Interfaces:

Serializable

public class SpeedUnit
extends Unit<SpeedUnit>

According to Wikipedia: Speed describes only how fast an object is moving, whereas velocity gives both how fast and in what direction the object is moving.

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 SpeedUnit	FOOT_PER_SECOND ft/s.
static SpeedUnit	KM_PER_HOUR km/h.
static SpeedUnit	KNOT knot.
static SpeedUnit	METER_PER_SECOND m/s.
static SpeedUnit	MILE_PER_HOUR mile/h.
static SpeedUnit	SI The SI unit for velocity is m/s.

Constructor Summary

Constructors

Constructor and Description
SpeedUnit(LengthUnit lengthUnit, TimeUnit timeUnit, String nameKey, String abbreviationKey, UnitSystem unitSystem) Build a speed unit from a length unit and a time unit.
SpeedUnit(String nameKey, String abbreviationKey, UnitSystem unitSystem, SpeedUnit referenceUnit, double conversionFactorToReferenceUnit) Build a speed unit based on another speed unit.

Method Summary

Modifier and Type	Method and Description
LengthUnit	getLengthUnit()
String	getSICoefficientsString()
SpeedUnit	getStandardUnit()
TimeUnit	getTimeUnit()

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 SpeedUnit SI

The SI unit for velocity is m/s.

METER_PER_SECOND

public static final SpeedUnit METER_PER_SECOND

m/s.

KM_PER_HOUR

public static final SpeedUnit KM_PER_HOUR

km/h.

MILE_PER_HOUR

public static final SpeedUnit MILE_PER_HOUR

mile/h.

FOOT_PER_SECOND

public static final SpeedUnit FOOT_PER_SECOND

ft/s.

KNOT

public static final SpeedUnit KNOT

knot.

Constructor Detail

SpeedUnit

public SpeedUnit(LengthUnit lengthUnit,
                 TimeUnit timeUnit,
                 String nameKey,
                 String abbreviationKey,
                 UnitSystem unitSystem)

Build a speed unit from a length unit and a time unit.

Parameters:

lengthUnit - the unit of length for the speed unit, e.g., meter

timeUnit - the unit of time for the speed unit, e.g., second

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

SpeedUnit

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

Build a speed unit based on another speed 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

getLengthUnit

public final LengthUnit getLengthUnit()

Returns:

lengthUnit

getTimeUnit

public final TimeUnit getTimeUnit()

Returns:

timeUnit

getStandardUnit

public final SpeedUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<SpeedUnit>

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

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)