org.djunits.unit

Class MoneyPerVolumeUnit

java.lang.Object

org.djunits.unit.Unit<U>

org.djunits.unit.LinearUnit<MoneyPerVolumeUnit>

org.djunits.unit.MoneyPerVolumeUnit

All Implemented Interfaces:

Serializable

public class MoneyPerVolumeUnit
extends LinearUnit<MoneyPerVolumeUnit>

MoneyPerVolumeUnit defines a unit for the cost or benefit per volume, e.g. the cost of a gallon of fuel.

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

$LastChangedDate: 2019-01-18 00:35:01 +0100 (Fri, 18 Jan 2019) $, @version $Revision: 324 $, by $Author: averbraeck $, initial version Sep 5, 2015

Author:

Alexander Verbraeck

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static MoneyPerVolumeUnit	EUR_PER_CUBIC_METER Euro per cubic meter.
static MoneyPerVolumeUnit	EUR_PER_LITER Euro per liter.
static MoneyPerVolumeUnit	USD_PER_GALLON_US_FLUID US$ per gallon (US).
static MoneyPerVolumeUnit	USD_PER_OUNCE_US_FLUID US$ per ounce (US).

Fields inherited from class org.djunits.unit.Unit

STANDARD_UNITS

Constructor Summary

Constructors

Constructor and Description
MoneyPerVolumeUnit(MoneyUnit moneyUnit, VolumeUnit volumeUnit, String name, String abbreviation) Build a user-defined money per volume unit from a money unit and an volume unit.
MoneyPerVolumeUnit(String name, String abbreviation, MoneyPerVolumeUnit referenceUnit, double scaleFactorToReferenceUnit) Build a user-defined MoneyPerVolumeUnit with a conversion factor to another MoneyPerVolumeUnit.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
MoneyUnit	getMoneyUnit()
String	getSICoefficientsString()
static MoneyPerVolumeUnit	getStandardMoneyPerVolumeUnit()
MoneyPerVolumeUnit	getStandardUnit()
VolumeUnit	getVolumeUnit()
int	hashCode()
protected static void	setStandardUnit(MoneyUnit standardMoneyUnit) Set the standard MoneyPerVolumeUnit in case the standard MoneyUnit changes, as the standard money unit is flexible.

Methods inherited from class org.djunits.unit.LinearUnit

equalsIgnoreNaming, getScale, getScaleFactor

Methods inherited from class org.djunits.unit.Unit

generateHashCode, getAbbreviation, getAbbreviationKey, getAllUnitsOfThisType, getName, getNameKey, getSICoefficients, getUnits, getUnitSystem, isBaseSIUnit, isLocalizable, lookupOrCreateSIUnitWithSICoefficients, lookupOrCreateUnitWithSICoefficients, lookupUnitWithSICoefficients, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EUR_PER_CUBIC_METER

public static final MoneyPerVolumeUnit EUR_PER_CUBIC_METER

Euro per cubic meter.

EUR_PER_LITER

public static final MoneyPerVolumeUnit EUR_PER_LITER

Euro per liter.

USD_PER_GALLON_US_FLUID

public static final MoneyPerVolumeUnit USD_PER_GALLON_US_FLUID

US$ per gallon (US).

USD_PER_OUNCE_US_FLUID

public static final MoneyPerVolumeUnit USD_PER_OUNCE_US_FLUID

US$ per ounce (US).

Constructor Detail

MoneyPerVolumeUnit

public MoneyPerVolumeUnit(MoneyUnit moneyUnit,
                          VolumeUnit volumeUnit,
                          String name,
                          String abbreviation)

Build a user-defined money per volume unit from a money unit and an volume unit.

Parameters:

moneyUnit - MoneyUnit; the unit of money for the money per volume unit, e.g., EUR

volumeUnit - VolumeUnit; the unit of volume for the money per volume unit, e.g., m^3

name - String; the key to the locale file for the long name of the unit

abbreviation - String; the key to the locale file for the abbreviation of the unit

MoneyPerVolumeUnit

public MoneyPerVolumeUnit(String name,
                          String abbreviation,
                          MoneyPerVolumeUnit referenceUnit,
                          double scaleFactorToReferenceUnit)

Build a user-defined MoneyPerVolumeUnit with a conversion factor to another MoneyPerVolumeUnit.

Parameters:

name - String; the long name of the unit

abbreviation - String; the abbreviation of the unit

referenceUnit - MoneyPerVolumeUnit; the unit to convert to

scaleFactorToReferenceUnit - double; multiply a value in this unit by the factor to convert to the given reference unit

Method Detail

getMoneyUnit

public final MoneyUnit getMoneyUnit()

Returns:

moneyUnit

getVolumeUnit

public final VolumeUnit getVolumeUnit()

Returns:

volumeUnit

setStandardUnit

protected static void setStandardUnit(MoneyUnit standardMoneyUnit)

Set the standard MoneyPerVolumeUnit in case the standard MoneyUnit changes, as the standard money unit is flexible.

Parameters:

standardMoneyUnit - MoneyUnit; the new standard money unit.

getStandardUnit

public final MoneyPerVolumeUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<MoneyPerVolumeUnit>

Returns:

the SI standard unit for this unit, or the de facto standard unit if SI is not available

getStandardMoneyPerVolumeUnit

public static MoneyPerVolumeUnit getStandardMoneyPerVolumeUnit()

Returns:

standard MoneyPerVolumeUnit

getSICoefficientsString

public final String getSICoefficientsString()

Specified by:

getSICoefficientsString in class Unit<MoneyPerVolumeUnit>

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)

hashCode

public int hashCode()

Overrides:

hashCode in class LinearUnit<MoneyPerVolumeUnit>

equals

public boolean equals(Object obj)

Overrides:

equals in class LinearUnit<MoneyPerVolumeUnit>