org.opentrafficsim.core.unit

Class EnergyUnit

java.lang.Object

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

org.opentrafficsim.core.unit.EnergyUnit

All Implemented Interfaces:

Serializable

public class EnergyUnit
extends Unit<EnergyUnit>

The units of energy.

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 EnergyUnit	BTU_ISO British thermal unit (ISO).
static EnergyUnit	BTU_IT British thermal unit (International Table).
static EnergyUnit	CALORIE_IT calorie (International Table).
static EnergyUnit	ELECTRONVOLT electronvolt.
static EnergyUnit	ERG erg (cgs).
static EnergyUnit	EXA_ELECTRONVOLT exa-electronvolt.
static EnergyUnit	FOOT_POUND_FORCE foot-pound force.
static EnergyUnit	GIGA_ELECTRONVOLT giga-electronvolt.
static EnergyUnit	GIGAWATT_HOUR gigawatt-hour.
static EnergyUnit	INCH_POUND_FORCE inch-pound force.
static EnergyUnit	JOULE Joule.
static EnergyUnit	KILO_ELECTRONVOLT kilo-electronvolt.
static EnergyUnit	KILOCALORIE kilocalorie.
static EnergyUnit	KILOWATT_HOUR kilowatt-hour.
static EnergyUnit	MEGA_ELECTRONVOLT mega-electronvolt.
static EnergyUnit	MEGAWATT_HOUR megawatt-hour.
static EnergyUnit	MICROWATT_HOUR microwatt-hour.
static EnergyUnit	MILLI_ELECTRONVOLT milli-electronvolt.
static EnergyUnit	MILLIWATT_HOUR milliwatt-hour.
static EnergyUnit	PETA_ELECTRONVOLT peta-electronvolt.
static EnergyUnit	SI The SI unit for energy is Joule.
static EnergyUnit	STHENE_METER sthene-meter (mts).
static EnergyUnit	TERA_ELECTRONVOLT tera-electronvolt.
static EnergyUnit	TERAWATT_HOUR terawatt-hour.
static EnergyUnit	WATT_HOUR watt-hour.

Constructor Summary

Constructors

Constructor and Description
EnergyUnit(LengthUnit lengthUnit, ForceUnit forceUnit, String nameKey, String abbreviationKey, UnitSystem unitSystem)
EnergyUnit(MassUnit massUnit, LengthUnit lengthUnit, TimeUnit timeUnit, String nameKey, String abbreviationKey, UnitSystem unitSystem)
EnergyUnit(String nameKey, String abbreviationKey, UnitSystem unitSystem, EnergyUnit referenceUnit, double conversionFactorToReferenceUnit)

Method Summary

Methods

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

The SI unit for energy is Joule.

JOULE

public static final EnergyUnit JOULE

Joule.

FOOT_POUND_FORCE

public static final EnergyUnit FOOT_POUND_FORCE

foot-pound force.

INCH_POUND_FORCE

public static final EnergyUnit INCH_POUND_FORCE

inch-pound force.

BTU_ISO

public static final EnergyUnit BTU_ISO

British thermal unit (ISO).

BTU_IT

public static final EnergyUnit BTU_IT

British thermal unit (International Table).

CALORIE_IT

public static final EnergyUnit CALORIE_IT

calorie (International Table).

KILOCALORIE

public static final EnergyUnit KILOCALORIE

kilocalorie.

WATT_HOUR

public static final EnergyUnit WATT_HOUR

watt-hour.

KILOWATT_HOUR

public static final EnergyUnit KILOWATT_HOUR

kilowatt-hour.

MEGAWATT_HOUR

public static final EnergyUnit MEGAWATT_HOUR

megawatt-hour.

GIGAWATT_HOUR

public static final EnergyUnit GIGAWATT_HOUR

gigawatt-hour.

TERAWATT_HOUR

public static final EnergyUnit TERAWATT_HOUR

terawatt-hour.

MILLIWATT_HOUR

public static final EnergyUnit MILLIWATT_HOUR

milliwatt-hour.

MICROWATT_HOUR

public static final EnergyUnit MICROWATT_HOUR

microwatt-hour.

ELECTRONVOLT

public static final EnergyUnit ELECTRONVOLT

electronvolt.

MILLI_ELECTRONVOLT

public static final EnergyUnit MILLI_ELECTRONVOLT

milli-electronvolt.

KILO_ELECTRONVOLT

public static final EnergyUnit KILO_ELECTRONVOLT

kilo-electronvolt.

MEGA_ELECTRONVOLT

public static final EnergyUnit MEGA_ELECTRONVOLT

mega-electronvolt.

GIGA_ELECTRONVOLT

public static final EnergyUnit GIGA_ELECTRONVOLT

giga-electronvolt.

TERA_ELECTRONVOLT

public static final EnergyUnit TERA_ELECTRONVOLT

tera-electronvolt.

PETA_ELECTRONVOLT

public static final EnergyUnit PETA_ELECTRONVOLT

peta-electronvolt.

EXA_ELECTRONVOLT

public static final EnergyUnit EXA_ELECTRONVOLT

exa-electronvolt.

STHENE_METER

public static final EnergyUnit STHENE_METER

sthene-meter (mts).

ERG

public static final EnergyUnit ERG

erg (cgs).

Constructor Detail

EnergyUnit

public EnergyUnit(MassUnit massUnit,
          LengthUnit lengthUnit,
          TimeUnit timeUnit,
          String nameKey,
          String abbreviationKey,
          UnitSystem unitSystem)

Parameters:

massUnit - the unit of mass for the energy unit, e.g., kilogram

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

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

EnergyUnit

public EnergyUnit(LengthUnit lengthUnit,
          ForceUnit forceUnit,
          String nameKey,
          String abbreviationKey,
          UnitSystem unitSystem)

Parameters:

lengthUnit - the unit of length for the energy unit, e.g., m

forceUnit - the unit of force for the energy unit, e.g., Newton

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

EnergyUnit

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

getTimeUnit

public final TimeUnit getTimeUnit()

Returns:

timeUnit

getStandardUnit

public final EnergyUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<EnergyUnit>

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

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)