org.opentrafficsim.core.unit

Class LinearDensityUnit

java.lang.Object

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

org.opentrafficsim.core.unit.LinearDensityUnit

All Implemented Interfaces:

Serializable

public class LinearDensityUnit
extends Unit<LinearDensityUnit>

Objects per unit of distance.

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

Version:

11 nov. 2014

Author:

Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static LinearDensityUnit	PER_KILOMETER 1/kilometer.
static LinearDensityUnit	PER_METER 1/meter.
static LinearDensityUnit	PER_MILLIMETER 1/millimeter.
static LinearDensityUnit	SI The SI unit for objects per unit of distance is 1/meter.

Constructor Summary

Constructors

Constructor and Description
LinearDensityUnit(LengthUnit lengthUnit, String nameKey, String abbreviationKey, UnitSystem unitSystem) Define frequency unit based on time.
LinearDensityUnit(String nameKey, String abbreviationKey, UnitSystem unitSystem, LinearDensityUnit referenceUnit, double conversionFactorToReferenceUnit) Build a unit with a conversion factor to another unit.

Method Summary

Methods

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

The SI unit for objects per unit of distance is 1/meter.

PER_METER

public static final LinearDensityUnit PER_METER

1/meter.

PER_KILOMETER

public static final LinearDensityUnit PER_KILOMETER

1/kilometer.

PER_MILLIMETER

public static final LinearDensityUnit PER_MILLIMETER

1/millimeter.

Constructor Detail

LinearDensityUnit

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

Define frequency unit based on time. You can define unit like "per second" (Hertz) here.

Parameters:

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

LinearDensityUnit

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

Build a unit with a conversion factor to another 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:

timeUnit

getStandardUnit

public final LinearDensityUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<LinearDensityUnit>

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

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)