org.opentrafficsim.core.unit

Class FrequencyUnit

java.lang.Object

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

org.opentrafficsim.core.unit.FrequencyUnit

All Implemented Interfaces:

Serializable

public class FrequencyUnit
extends Unit<FrequencyUnit>

Standard frequency units based on time.

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 FrequencyUnit	GIGAHERTZ gigaHertz.
static FrequencyUnit	HERTZ Hertz.
static FrequencyUnit	KILOHERTZ kiloHertz.
static FrequencyUnit	MEGAHERTZ megaHertz.
static FrequencyUnit	PER_DAY 1/day.
static FrequencyUnit	PER_HOUR 1/hour.
static FrequencyUnit	PER_MILLISECOND 1/millisecond.
static FrequencyUnit	PER_MINUTE 1/min.
static FrequencyUnit	PER_SECOND 1/s.
static FrequencyUnit	PER_WEEK 1/week.
static FrequencyUnit	RPM Revolutions per minute = 1/60 Hz.
static FrequencyUnit	SI The SI unit for frequency is Hertz.
static FrequencyUnit	TERAHERTZ teraHertz.

Constructor Summary

Constructors

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

Method Summary

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

The SI unit for frequency is Hertz.

HERTZ

public static final FrequencyUnit HERTZ

Hertz.

KILOHERTZ

public static final FrequencyUnit KILOHERTZ

kiloHertz.

MEGAHERTZ

public static final FrequencyUnit MEGAHERTZ

megaHertz.

GIGAHERTZ

public static final FrequencyUnit GIGAHERTZ

gigaHertz.

TERAHERTZ

public static final FrequencyUnit TERAHERTZ

teraHertz.

RPM

public static final FrequencyUnit RPM

Revolutions per minute = 1/60 Hz.

PER_MILLISECOND

public static final FrequencyUnit PER_MILLISECOND

1/millisecond.

PER_SECOND

public static final FrequencyUnit PER_SECOND

1/s.

PER_MINUTE

public static final FrequencyUnit PER_MINUTE

1/min.

PER_HOUR

public static final FrequencyUnit PER_HOUR

1/hour.

PER_DAY

public static final FrequencyUnit PER_DAY

1/day.

PER_WEEK

public static final FrequencyUnit PER_WEEK

1/week.

Constructor Detail

FrequencyUnit

public FrequencyUnit(TimeUnit timeUnit,
                     String nameKey,
                     String abbreviationKey,
                     UnitSystem unitSystem)

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

Parameters:

timeUnit - the unit of time for the frequency 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

FrequencyUnit

public FrequencyUnit(String nameKey,
                     String abbreviationKey,
                     UnitSystem unitSystem,
                     FrequencyUnit 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

getTimeUnit

public final TimeUnit getTimeUnit()

Returns:

timeUnit

getStandardUnit

public final FrequencyUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<FrequencyUnit>

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

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)