org.djunits.unit

Class TimeUnit

java.lang.Object

org.djunits.unit.Unit<U>

org.djunits.unit.LinearUnit<TimeUnit>

org.djunits.unit.TimeUnit

All Implemented Interfaces:

Serializable

public class TimeUnit
extends LinearUnit<TimeUnit>

Standard time units.

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

$LastChangedDate: 2016-05-28 14:25:52 +0200 (Sat, 28 May 2016) $, @version $Revision: 202 $, by $Author: averbraeck $, initial version May 15, 2014

Author:

Alexander Verbraeck

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static TimeUnit	DAY day.
static TimeUnit	HOUR hour.
static TimeUnit	MILLISECOND millisecond.
static TimeUnit	MINUTE minute.
static TimeUnit	SECOND second.
static TimeUnit	SI The SI unit for time is second.
static TimeUnit	WEEK week.

Fields inherited from class org.djunits.unit.Unit

scale, STANDARD_UNITS

Constructor Summary

Constructors

Constructor and Description
TimeUnit(String name, String abbreviation, UnitSystem unitSystem, TimeUnit referenceUnit, double conversionFactorToReferenceUnit) Build a user-defined TimeUnit with a conversion factor to another TimeUnit.

Method Summary

Modifier and Type	Method and Description
String	getSICoefficientsString()
TimeUnit	getStandardUnit()

Methods inherited from class org.djunits.unit.LinearUnit

getConversionFactorToStandardUnit, getScale

Methods inherited from class org.djunits.unit.Unit

equals, getAbbreviation, getAbbreviationKey, getAllUnitsOfThisType, 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

SI

public static final TimeUnit SI

The SI unit for time is second.

SECOND

public static final TimeUnit SECOND

second.

MILLISECOND

public static final TimeUnit MILLISECOND

millisecond.

MINUTE

public static final TimeUnit MINUTE

minute.

HOUR

public static final TimeUnit HOUR

hour.

DAY

public static final TimeUnit DAY

day.

WEEK

public static final TimeUnit WEEK

week.

Constructor Detail

TimeUnit

public TimeUnit(String name,
                String abbreviation,
                UnitSystem unitSystem,
                TimeUnit referenceUnit,
                double conversionFactorToReferenceUnit)

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

Parameters:

name - the long name of the unit

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

getStandardUnit

public final TimeUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<TimeUnit>

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

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)