org.opentrafficsim.core.unit

Class DensityUnit

java.lang.Object

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

org.opentrafficsim.core.unit.DensityUnit

All Implemented Interfaces:

Serializable

public class DensityUnit
extends Unit<DensityUnit>

Standard density units based on mass and length.

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 DensityUnit	GRAM_PER_CENTIMETER_3 g/cm^3.
static DensityUnit	KG_PER_METER_3 kg/m^3.
static DensityUnit	SI The SI unit for standard density is kg/m^3.

Constructor Summary

Constructors

Constructor and Description
DensityUnit(MassUnit massUnit, LengthUnit lengthUnit, String nameKey, String abbreviationKey, UnitSystem unitSystem) Define density units based on mass and length.
DensityUnit(String nameKey, String abbreviationKey, UnitSystem unitSystem, DensityUnit referenceUnit, double conversionFactorToReferenceUnit)

Method Summary

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

The SI unit for standard density is kg/m^3.

KG_PER_METER_3

public static final DensityUnit KG_PER_METER_3

kg/m^3.

GRAM_PER_CENTIMETER_3

public static final DensityUnit GRAM_PER_CENTIMETER_3

g/cm^3.

Constructor Detail

DensityUnit

public DensityUnit(MassUnit massUnit,
                   LengthUnit lengthUnit,
                   String nameKey,
                   String abbreviationKey,
                   UnitSystem unitSystem)

Define density units based on mass and length. You can define units like kg/m^3 here.

Parameters:

massUnit - the unit of mass for the density unit, e.g., kg

lengthUnit - the unit of length for the density 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

DensityUnit

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

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

getMassUnit

public final MassUnit getMassUnit()

Returns:

massUnit

getLengthUnit

public final LengthUnit getLengthUnit()

Returns:

lengthUnit

getStandardUnit

public final DensityUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<DensityUnit>

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

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)