org.djunits.value.vdouble.scalar

Class Duration

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vdouble.scalar.AbstractDoubleScalar<U,R>

org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel<DurationUnit,Duration>

org.djunits.value.vdouble.scalar.Duration

All Implemented Interfaces:

Serializable, Comparable<Duration>, MathFunctionsAbs<Duration>, MathFunctionsRel<Duration>, Relative, Value<DurationUnit>, DoubleMathFunctions<Duration>, DoubleScalarInterface

public class Duration
extends AbstractDoubleScalarRel<DurationUnit,Duration>

Easy access methods for the Relative Duration DoubleScalar. Instead of:

 DoubleScalar<DurationUnit> value = new DoubleScalar<DurationUnit>(100.0, DurationUnit.SI);
 

we can now write:

 Duration value = new Duration(100.0, DurationUnit.SI);
 

The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit used are compatible.

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

$LastChangedDate: 2015-12-22 04:32:39 +0100 (Tue, 22 Dec 2015) $, @version $Revision: 180 $, by $Author: averbraeck $, initial version Sep 1, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Duration	NaN constant with value NaN.
static Duration	NEG_MAXVALUE constant with value -MAX_VALUE.
static Duration	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static Duration	POS_MAXVALUE constant with value MAX_VALUE.
static Duration	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static Duration	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors

Constructor and Description
Duration(double value, DurationUnit unit) Construct Duration scalar.
Duration(Duration value) Construct Duration scalar.

Method Summary

Modifier and Type	Method and Description
static Duration	createSI(double value) Construct Duration scalar.
Dimensionless	divideBy(Duration v) Calculate the division of Duration and Duration, which results in a Dimensionless scalar.
Time	instantiateAbs(double value, TimeUnit unit) Construct a new Absolute Immutable DoubleScalar of the right type.
Duration	instantiateRel(double value, DurationUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static Duration	interpolate(Duration zero, Duration one, double ratio) Interpolate between two values.
static Duration	max(Duration r1, Duration r2) Return the maximum value of two relative scalars.
static Duration	max(Duration r1, Duration r2, Duration... rn) Return the maximum value of more than two relative scalars.
static Duration	min(Duration r1, Duration r2) Return the minimum value of two relative scalars.
static Duration	min(Duration r1, Duration r2, Duration... rn) Return the minimum value of more than two relative scalars.
Speed	multiplyBy(Acceleration v) Calculate the multiplication of Duration and Acceleration, which results in a Speed scalar.
ElectricalCharge	multiplyBy(ElectricalCurrent v) Calculate the multiplication of Duration and ElectricalCurrent, which results in a ElectricalCharge scalar.
Mass	multiplyBy(FlowMass v) Calculate the multiplication of Duration and FlowMass, which results in a Mass scalar.
Volume	multiplyBy(FlowVolume v) Calculate the multiplication of Duration and FlowVolume, which results in a Volume scalar.
Dimensionless	multiplyBy(Frequency v) Calculate the multiplication of Duration and Frequency, which results in a Dimensionless scalar.
Money	multiplyBy(MoneyPerDuration v) Calculate the multiplication of Duration and MoneyPerDuration, which results in a Money scalar.
Energy	multiplyBy(Power v) Calculate the multiplication of Duration and Power, which results in a Energy scalar.
Length	multiplyBy(Speed v) Calculate the multiplication of Duration and Speed, which results in a Length scalar.
Time	plus(Time v) Relative scalar plus Absolute scalar = Absolute scalar.
static Duration	valueOf(String text) Returns a Duration representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel

abs, ceil, divideBy, floor, minus, multiplyBy, neg, plus, rint, round

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit, stringOf, stringOfDefaultLocale, textualStringOf, textualStringOfDefaultLocale

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final Duration ZERO

constant with value zero.

NaN

public static final Duration NaN

constant with value NaN.

POSITIVE_INFINITY

public static final Duration POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Duration NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Duration POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Duration NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

Duration

public Duration(double value,
                DurationUnit unit)

Construct Duration scalar.

Parameters:

value - double value

unit - unit for the double value

Duration

public Duration(Duration value)

Construct Duration scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final Duration instantiateRel(double value,
                                     DurationUnit unit)

Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateRel in class AbstractDoubleScalarRel<DurationUnit,Duration>

Parameters:

value - double; the double value

unit - U; the unit

Returns:

R a new relative instance of the DoubleScalar of the right type

instantiateAbs

public final Time instantiateAbs(double value,
                                 TimeUnit unit)

Construct a new Absolute Immutable DoubleScalar of the right type. Each extending class must implement this method.

Parameters:

value - the double value

unit - the unit

Returns:

A a new absolute instance of the DoubleScalar of the right type

createSI

public static final Duration createSI(double value)

Construct Duration scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

public static Duration interpolate(Duration zero,
                                   Duration one,
                                   double ratio)

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

plus

public final Time plus(Time v)

Relative scalar plus Absolute scalar = Absolute scalar.

Parameters:

v - the value to add

Returns:

sum of this value and v as a new object

max

public static Duration max(Duration r1,
                           Duration r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the maximum value of two relative scalars

max

public static Duration max(Duration r1,
                           Duration r2,
                           Duration... rn)

Return the maximum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the maximum value of more than two relative scalars

min

public static Duration min(Duration r1,
                           Duration r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the minimum value of two relative scalars

min

public static Duration min(Duration r1,
                           Duration r2,
                           Duration... rn)

Return the minimum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the minimum value of more than two relative scalars

valueOf

public static Duration valueOf(String text)
                        throws IllegalArgumentException

Returns a Duration representation of a textual representation of a value with a unit. The String representation that can be parsed is the double value in the unit, followed by the official abbreviation of the unit. Spaces are allowed, but not necessary, between the value and the unit.

Parameters:

text - String; the textual representation to parse into a Duration

Returns:

the String representation of the value in its unit, followed by the official abbreviation of the unit

Throws:

IllegalArgumentException - when the text cannot be parsed

divideBy

public final Dimensionless divideBy(Duration v)

Calculate the division of Duration and Duration, which results in a Dimensionless scalar.

Parameters:

v - Duration scalar

Returns:

Dimensionless scalar as a division of Duration and Duration

multiplyBy

public final Dimensionless multiplyBy(Frequency v)

Calculate the multiplication of Duration and Frequency, which results in a Dimensionless scalar.

Parameters:

v - Duration scalar

Returns:

Dimensionless scalar as a multiplication of Duration and Frequency

multiplyBy

public final ElectricalCharge multiplyBy(ElectricalCurrent v)

Calculate the multiplication of Duration and ElectricalCurrent, which results in a ElectricalCharge scalar.

Parameters:

v - Duration scalar

Returns:

ElectricalCharge scalar as a multiplication of Duration and ElectricalCurrent

multiplyBy

public final Mass multiplyBy(FlowMass v)

Calculate the multiplication of Duration and FlowMass, which results in a Mass scalar.

Parameters:

v - Duration scalar

Returns:

Mass scalar as a multiplication of Duration and FlowMass

multiplyBy

public final Volume multiplyBy(FlowVolume v)

Calculate the multiplication of Duration and FlowVolume, which results in a Volume scalar.

Parameters:

v - Duration scalar

Returns:

Volume scalar as a multiplication of Duration and FlowVolume

multiplyBy

public final Speed multiplyBy(Acceleration v)

Calculate the multiplication of Duration and Acceleration, which results in a Speed scalar.

Parameters:

v - Duration scalar

Returns:

Speed scalar as a multiplication of Duration and Acceleration

multiplyBy

public final Energy multiplyBy(Power v)

Calculate the multiplication of Duration and Power, which results in a Energy scalar.

Parameters:

v - Duration scalar

Returns:

Energy scalar as a multiplication of Duration and Power

multiplyBy

public final Length multiplyBy(Speed v)

Calculate the multiplication of Duration and Speed, which results in a Length scalar.

Parameters:

v - Duration scalar

Returns:

Length scalar as a multiplication of Duration and Speed

multiplyBy

public final Money multiplyBy(MoneyPerDuration v)

Calculate the multiplication of Duration and MoneyPerDuration, which results in a Money scalar.

Parameters:

v - Duration scalar

Returns:

Money scalar as a multiplication of Duration and MoneyPerDuration