org.djunits.unit

Class MoneyPerTimeUnit

java.lang.Object

org.djunits.unit.Unit<MoneyPerTimeUnit>

org.djunits.unit.MoneyPerTimeUnit

All Implemented Interfaces:

Serializable

public class MoneyPerTimeUnit
extends Unit<MoneyPerTimeUnit>

MoneyPerTimeUnit defines a unit for the cost or benefit per time, e.g. wage per hour.

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

$LastChangedDate: 2015-10-04 20:48:33 +0200 (Sun, 04 Oct 2015) $, @version $Revision: 87 $, 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 MoneyPerTimeUnit	EUR_PER_DAY Euro per day.
static MoneyPerTimeUnit	EUR_PER_HOUR Euro per hour.
static MoneyPerTimeUnit	USD_PER_DAY US$ per day.
static MoneyPerTimeUnit	USD_PER_HOUR US$ per hour.

Constructor Summary

Constructors

Constructor and Description
MoneyPerTimeUnit(MoneyUnit moneyUnit, TimeUnit timeUnit, String name, String abbreviation) Build a user-defined money per time unit from a money unit and an time unit.
MoneyPerTimeUnit(String name, String abbreviation, MoneyPerTimeUnit referenceUnit, double conversionFactorToReferenceUnit) Build a user-defined MoneyPerTimeUnit with a conversion factor to another MoneyPerTimeUnit.

Method Summary

Modifier and Type	Method and Description
MoneyUnit	getMoneyUnit()
String	getSICoefficientsString()
static MoneyPerTimeUnit	getStandardMoneyPerTimeUnit()
MoneyPerTimeUnit	getStandardUnit()
TimeUnit	getTimeUnit()
protected static void	setStandardUnit(MoneyUnit standardMoneyUnit) Set the standard MoneyPerTimeUnit in case the standard MoneyUnit changes, as the standard money unit is flexible.

Methods inherited from class org.djunits.unit.Unit

equals, getAbbreviation, getAbbreviationKey, getAllUnitsOfThisType, getConversionFactorToStandardUnit, getName, getNameKey, getSICoefficients, getUnits, getUnitSystem, hashCode, isLocalizable, lookupOrCreateSIUnitWithSICoefficients, lookupOrCreateUnitWithSICoefficients, lookupUnitWithSICoefficients, toString

Methods inherited from class java.lang.Object

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

Field Detail

EUR_PER_HOUR

public static final MoneyPerTimeUnit EUR_PER_HOUR

Euro per hour.

EUR_PER_DAY

public static final MoneyPerTimeUnit EUR_PER_DAY

Euro per day.

USD_PER_HOUR

public static final MoneyPerTimeUnit USD_PER_HOUR

US$ per hour.

USD_PER_DAY

public static final MoneyPerTimeUnit USD_PER_DAY

US$ per day.

Constructor Detail

MoneyPerTimeUnit

public MoneyPerTimeUnit(MoneyUnit moneyUnit,
                        TimeUnit timeUnit,
                        String name,
                        String abbreviation)

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

Parameters:

moneyUnit - the unit of money for the money per time unit, e.g., EUR

timeUnit - the unit of time for the money per time unit, e.g., hour

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

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

MoneyPerTimeUnit

public MoneyPerTimeUnit(String name,
                        String abbreviation,
                        MoneyPerTimeUnit referenceUnit,
                        double conversionFactorToReferenceUnit)

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

Parameters:

name - the long name of the unit

abbreviation - the abbreviation of the unit

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

getMoneyUnit

public final MoneyUnit getMoneyUnit()

Returns:

moneyUnit

getTimeUnit

public final TimeUnit getTimeUnit()

Returns:

timeUnit

setStandardUnit

protected static void setStandardUnit(MoneyUnit standardMoneyUnit)

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

Parameters:

standardMoneyUnit - the new standard money unit.

getStandardUnit

public final MoneyPerTimeUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<MoneyPerTimeUnit>

Returns:

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

getStandardMoneyPerTimeUnit

public static MoneyPerTimeUnit getStandardMoneyPerTimeUnit()

Returns:

standard MoneyPerTimeUnit

getSICoefficientsString

public final String getSICoefficientsString()

Specified by:

getSICoefficientsString in class Unit<MoneyPerTimeUnit>

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)