org.djunits.value.vfloat.scalar

Class FloatDuration

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.AbstractFloatScalar<U,R>

org.djunits.value.vfloat.scalar.AbstractFloatScalarRel<DurationUnit,FloatDuration>

org.djunits.value.vfloat.scalar.FloatDuration

All Implemented Interfaces:

Serializable, Comparable<FloatDuration>, MathFunctionsAbs<FloatDuration>, MathFunctionsRel<FloatDuration>, Relative, Value<DurationUnit>, FloatMathFunctions<FloatDuration>, FloatScalarInterface

public class FloatDuration
extends AbstractFloatScalarRel<DurationUnit,FloatDuration>

Easy access methods for the %Type% FloatScalar. Instead of:

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

we can now write:

 FloatDuration value = new FloatDuration(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 FloatDuration	NaN constant with value NaN.
static FloatDuration	NEG_MAXVALUE constant with value -MAX_VALUE.
static FloatDuration	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static FloatDuration	POS_MAXVALUE constant with value MAX_VALUE.
static FloatDuration	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static FloatDuration	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

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

Constructor Summary

Constructors

Constructor and Description
FloatDuration(double value, DurationUnit unit) Construct FloatDuration scalar using a double value.
FloatDuration(FloatDuration value) Construct FloatDuration scalar.
FloatDuration(float value, DurationUnit unit) Construct FloatDuration scalar.

Method Summary

Modifier and Type	Method and Description
static FloatDuration	createSI(float value) Construct FloatDuration scalar.
FloatDimensionless	divideBy(FloatDuration v) Calculate the division of FloatDuration and FloatDuration, which results in a FloatDimensionless scalar.
FloatTime	instantiateAbs(float value, TimeUnit unit) Construct a new Absolute Immutable FloatScalar of the right type.
FloatDuration	instantiateRel(float value, DurationUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatDuration	interpolate(FloatDuration zero, FloatDuration one, float ratio) Interpolate between two values.
static FloatDuration	max(FloatDuration r1, FloatDuration r2) Return the maximum value of two relative scalars.
static FloatDuration	max(FloatDuration r1, FloatDuration r2, FloatDuration... rn) Return the maximum value of more than two relative scalars.
static FloatDuration	min(FloatDuration r1, FloatDuration r2) Return the minimum value of two relative scalars.
static FloatDuration	min(FloatDuration r1, FloatDuration r2, FloatDuration... rn) Return the minimum value of more than two relative scalars.
FloatSpeed	multiplyBy(FloatAcceleration v) Calculate the multiplication of FloatDuration and FloatAcceleration, which results in a FloatSpeed scalar.
FloatElectricalCharge	multiplyBy(FloatElectricalCurrent v) Calculate the multiplication of FloatDuration and FloatElectricalCurrent, which results in a FloatElectricalCharge scalar.
FloatMass	multiplyBy(FloatFlowMass v) Calculate the multiplication of FloatDuration and FloatFlowMass, which results in a FloatMass scalar.
FloatVolume	multiplyBy(FloatFlowVolume v) Calculate the multiplication of FloatDuration and FloatFlowVolume, which results in a FloatVolume scalar.
FloatDimensionless	multiplyBy(FloatFrequency v) Calculate the multiplication of FloatDuration and FloatFrequency, which results in a FloatDimensionless scalar.
FloatMoney	multiplyBy(FloatMoneyPerDuration v) Calculate the multiplication of FloatDuration and FloatMoneyPerDuration, which results in a FloatMoney scalar.
FloatEnergy	multiplyBy(FloatPower v) Calculate the multiplication of FloatDuration and FloatPower, which results in a FloatEnergy scalar.
FloatLength	multiplyBy(FloatSpeed v) Calculate the multiplication of FloatDuration and FloatSpeed, which results in a FloatLength scalar.
FloatTime	plus(FloatTime v) Relative scalar plus Absolute scalar = Absolute scalar.
static FloatDuration	valueOf(String text) Returns a FloatDuration representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalarRel

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

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

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.vfloat.FloatMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final FloatDuration ZERO

constant with value zero.

NaN

public static final FloatDuration NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatDuration POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatDuration NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatDuration POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatDuration NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatDuration

public FloatDuration(float value,
                     DurationUnit unit)

Construct FloatDuration scalar.

Parameters:

value - float value

unit - unit for the float value

FloatDuration

public FloatDuration(FloatDuration value)

Construct FloatDuration scalar.

Parameters:

value - Scalar from which to construct this instance

FloatDuration

public FloatDuration(double value,
                     DurationUnit unit)

Construct FloatDuration scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatDuration instantiateRel(float value,
                                          DurationUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<DurationUnit,FloatDuration>

Parameters:

value - float; the float value

unit - U; the unit

Returns:

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

createSI

public static final FloatDuration createSI(float value)

Construct FloatDuration scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

instantiateAbs

public final FloatTime instantiateAbs(float value,
                                      TimeUnit unit)

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

Parameters:

value - the float value

unit - the unit

Returns:

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

interpolate

public static FloatDuration interpolate(FloatDuration zero,
                                        FloatDuration one,
                                        float 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 FloatTime plus(FloatTime 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 FloatDuration max(FloatDuration r1,
                                FloatDuration 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 FloatDuration max(FloatDuration r1,
                                FloatDuration r2,
                                FloatDuration... 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 FloatDuration min(FloatDuration r1,
                                FloatDuration 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 FloatDuration min(FloatDuration r1,
                                FloatDuration r2,
                                FloatDuration... 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 FloatDuration valueOf(String text)
                             throws IllegalArgumentException

Returns a FloatDuration 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 FloatDuration

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 FloatDimensionless divideBy(FloatDuration v)

Calculate the division of FloatDuration and FloatDuration, which results in a FloatDimensionless scalar.

Parameters:

v - FloatDuration scalar

Returns:

FloatDimensionless scalar as a division of FloatDuration and FloatDuration

multiplyBy

public final FloatDimensionless multiplyBy(FloatFrequency v)

Calculate the multiplication of FloatDuration and FloatFrequency, which results in a FloatDimensionless scalar.

Parameters:

v - FloatDuration scalar

Returns:

FloatDimensionless scalar as a multiplication of FloatDuration and FloatFrequency

multiplyBy

public final FloatElectricalCharge multiplyBy(FloatElectricalCurrent v)

Calculate the multiplication of FloatDuration and FloatElectricalCurrent, which results in a FloatElectricalCharge scalar.

Parameters:

v - FloatDuration scalar

Returns:

FloatElectricalCharge scalar as a multiplication of FloatDuration and FloatElectricalCurrent

multiplyBy

public final FloatMass multiplyBy(FloatFlowMass v)

Calculate the multiplication of FloatDuration and FloatFlowMass, which results in a FloatMass scalar.

Parameters:

v - FloatDuration scalar

Returns:

FloatMass scalar as a multiplication of FloatDuration and FloatFlowMass

multiplyBy

public final FloatVolume multiplyBy(FloatFlowVolume v)

Calculate the multiplication of FloatDuration and FloatFlowVolume, which results in a FloatVolume scalar.

Parameters:

v - FloatDuration scalar

Returns:

FloatVolume scalar as a multiplication of FloatDuration and FloatFlowVolume

multiplyBy

public final FloatSpeed multiplyBy(FloatAcceleration v)

Calculate the multiplication of FloatDuration and FloatAcceleration, which results in a FloatSpeed scalar.

Parameters:

v - FloatDuration scalar

Returns:

FloatSpeed scalar as a multiplication of FloatDuration and FloatAcceleration

multiplyBy

public final FloatEnergy multiplyBy(FloatPower v)

Calculate the multiplication of FloatDuration and FloatPower, which results in a FloatEnergy scalar.

Parameters:

v - FloatDuration scalar

Returns:

FloatEnergy scalar as a multiplication of FloatDuration and FloatPower

multiplyBy

public final FloatLength multiplyBy(FloatSpeed v)

Calculate the multiplication of FloatDuration and FloatSpeed, which results in a FloatLength scalar.

Parameters:

v - FloatDuration scalar

Returns:

FloatLength scalar as a multiplication of FloatDuration and FloatSpeed

multiplyBy

public final FloatMoney multiplyBy(FloatMoneyPerDuration v)

Calculate the multiplication of FloatDuration and FloatMoneyPerDuration, which results in a FloatMoney scalar.

Parameters:

v - FloatDuration scalar

Returns:

FloatMoney scalar as a multiplication of FloatDuration and FloatMoneyPerDuration