org.opentrafficsim.core.unit

Class VolumeUnit

java.lang.Object

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

org.opentrafficsim.core.unit.VolumeUnit

All Implemented Interfaces:

Serializable

public class VolumeUnit
extends Unit<VolumeUnit>

VolumeUnit defines a number of common units for volumes.

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 VolumeUnit	CUBIC_CENTIMETER cm^3.
static VolumeUnit	CUBIC_DECIMETER dm^3.
static VolumeUnit	CUBIC_FOOT ft^3.
static VolumeUnit	CUBIC_INCH in^3.
static VolumeUnit	CUBIC_KM km^3.
static VolumeUnit	CUBIC_METER m^3.
static VolumeUnit	CUBIC_MILE mile^3.
static VolumeUnit	CUBIC_YARD yd^3.
static VolumeUnit	GALLON_IMP gallon (imperial).
static VolumeUnit	GALLON_US_FLUID gallon (US), fluids.
static VolumeUnit	LITER liter.
static VolumeUnit	OUNCE_IMP_FLUID ounce (fluid imperial).
static VolumeUnit	OUNCE_US_FLUID ounce (fluid US).
static VolumeUnit	PINT_IMP pint (imperial).
static VolumeUnit	PINT_US_FLUID pint (fluid US).
static VolumeUnit	QUART_IMP quart (imperial).
static VolumeUnit	QUART_US_FLUID quart (fluid US).
static VolumeUnit	SI The SI unit for volume is m^3.

Constructor Summary

Constructors

Constructor and Description
VolumeUnit(LengthUnit lengthUnit, String nameKey, String abbreviationKey, UnitSystem unitSystem) Define volume unit based on length, e.g.
VolumeUnit(String nameKey, String abbreviationKey, UnitSystem unitSystem, VolumeUnit referenceUnit, double conversionFactorToReferenceUnit) This constructor constructs a unit out of another defined unit, e.g.

Method Summary

Modifier and Type	Method and Description
LengthUnit	getLengthUnit()
String	getSICoefficientsString()
VolumeUnit	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 VolumeUnit SI

The SI unit for volume is m^3.

CUBIC_METER

public static final VolumeUnit CUBIC_METER

m^3.

CUBIC_DECIMETER

public static final VolumeUnit CUBIC_DECIMETER

dm^3.

LITER

public static final VolumeUnit LITER

liter.

CUBIC_CENTIMETER

public static final VolumeUnit CUBIC_CENTIMETER

cm^3.

CUBIC_KM

public static final VolumeUnit CUBIC_KM

km^3.

CUBIC_MILE

public static final VolumeUnit CUBIC_MILE

mile^3.

CUBIC_FOOT

public static final VolumeUnit CUBIC_FOOT

ft^3.

CUBIC_INCH

public static final VolumeUnit CUBIC_INCH

in^3.

CUBIC_YARD

public static final VolumeUnit CUBIC_YARD

yd^3.

GALLON_US_FLUID

public static final VolumeUnit GALLON_US_FLUID

gallon (US), fluids.

GALLON_IMP

public static final VolumeUnit GALLON_IMP

gallon (imperial).

OUNCE_US_FLUID

public static final VolumeUnit OUNCE_US_FLUID

ounce (fluid US).

OUNCE_IMP_FLUID

public static final VolumeUnit OUNCE_IMP_FLUID

ounce (fluid imperial).

PINT_US_FLUID

public static final VolumeUnit PINT_US_FLUID

pint (fluid US).

PINT_IMP

public static final VolumeUnit PINT_IMP

pint (imperial).

QUART_US_FLUID

public static final VolumeUnit QUART_US_FLUID

quart (fluid US).

QUART_IMP

public static final VolumeUnit QUART_IMP

quart (imperial).

Constructor Detail

VolumeUnit

public VolumeUnit(LengthUnit lengthUnit,
                  String nameKey,
                  String abbreviationKey,
                  UnitSystem unitSystem)

Define volume unit based on length, e.g. a m^3 is based on meters.

Parameters:

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

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

VolumeUnit

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

This constructor constructs a unit out of another defined unit, e.g. quart is 0.25 gallon.

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

getStandardUnit

public final VolumeUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<VolumeUnit>

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

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)