org.djunits.value.vfloat.scalar

Class FloatFlowVolume

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<FlowVolumeUnit,FloatFlowVolume>

org.djunits.value.vfloat.scalar.FloatFlowVolume

All Implemented Interfaces:

Serializable, Comparable<FloatFlowVolume>, MathFunctionsAbs<FloatFlowVolume>, MathFunctionsRel<FloatFlowVolume>, Relative, Value<FlowVolumeUnit>, FloatMathFunctions<FloatFlowVolume>, FloatScalarInterface

public class FloatFlowVolume
extends AbstractFloatScalarRel<FlowVolumeUnit,FloatFlowVolume>

Easy access methods for the FlowVolume FloatScalar, which is relative by definition. An example is Speed. Instead of:

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

we can now write:

 FloatFlowVolume value = new FloatFlowVolume(100.0, FlowVolumeUnit.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 DJUNITS License.

$LastChangedDate: 2019-03-03 00:53:50 +0100 (Sun, 03 Mar 2019) $, @version $Revision: 349 $, by $Author: averbraeck $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FloatFlowVolume	NaN constant with value NaN.
static FloatFlowVolume	NEG_MAXVALUE constant with value -MAX_VALUE.
static FloatFlowVolume	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static FloatFlowVolume	POS_MAXVALUE constant with value MAX_VALUE.
static FloatFlowVolume	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static FloatFlowVolume	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
FloatFlowVolume(double value, FlowVolumeUnit unit) Construct FloatFlowVolume scalar using a double value.
FloatFlowVolume(FloatFlowVolume value) Construct FloatFlowVolume scalar.
FloatFlowVolume(float value, FlowVolumeUnit unit) Construct FloatFlowVolume scalar.

Method Summary

Modifier and Type	Method and Description
static FloatFlowVolume	createSI(float value) Construct FloatFlowVolume scalar.
FloatSpeed	divideBy(FloatArea v) Calculate the division of FloatFlowVolume and FloatArea, which results in a FloatSpeed scalar.
FloatDimensionless	divideBy(FloatFlowVolume v) Calculate the division of FloatFlowVolume and FloatFlowVolume, which results in a FloatDimensionless scalar.
FloatVolume	divideBy(FloatFrequency v) Calculate the division of FloatFlowVolume and FloatFrequency, which results in a FloatVolume scalar.
FloatArea	divideBy(FloatSpeed v) Calculate the division of FloatFlowVolume and FloatSpeed, which results in a FloatArea scalar.
FloatFrequency	divideBy(FloatVolume v) Calculate the division of FloatFlowVolume and FloatVolume, which results in a FloatFrequency scalar.
FloatFlowVolume	instantiateRel(float value, FlowVolumeUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatFlowVolume	interpolate(FloatFlowVolume zero, FloatFlowVolume one, float ratio) Interpolate between two values.
static FloatFlowVolume	max(FloatFlowVolume r1, FloatFlowVolume r2) Return the maximum value of two relative scalars.
static FloatFlowVolume	max(FloatFlowVolume r1, FloatFlowVolume r2, FloatFlowVolume... rn) Return the maximum value of more than two relative scalars.
static FloatFlowVolume	min(FloatFlowVolume r1, FloatFlowVolume r2) Return the minimum value of two relative scalars.
static FloatFlowVolume	min(FloatFlowVolume r1, FloatFlowVolume r2, FloatFlowVolume... rn) Return the minimum value of more than two relative scalars.
FloatVolume	multiplyBy(FloatDuration v) Calculate the multiplication of FloatFlowVolume and FloatDuration, which results in a FloatVolume scalar.
static FloatFlowVolume	valueOf(String text) Returns a FloatFlowVolume 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 FloatFlowVolume ZERO

constant with value zero.

NaN

public static final FloatFlowVolume NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatFlowVolume POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatFlowVolume NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatFlowVolume POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatFlowVolume NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatFlowVolume

public FloatFlowVolume(float value,
                       FlowVolumeUnit unit)

Construct FloatFlowVolume scalar.

Parameters:

value - float value

unit - unit for the float value

FloatFlowVolume

public FloatFlowVolume(FloatFlowVolume value)

Construct FloatFlowVolume scalar.

Parameters:

value - Scalar from which to construct this instance

FloatFlowVolume

public FloatFlowVolume(double value,
                       FlowVolumeUnit unit)

Construct FloatFlowVolume scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatFlowVolume instantiateRel(float value,
                                            FlowVolumeUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<FlowVolumeUnit,FloatFlowVolume>

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 FloatFlowVolume createSI(float value)

Construct FloatFlowVolume scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

public static FloatFlowVolume interpolate(FloatFlowVolume zero,
                                          FloatFlowVolume 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

max

public static FloatFlowVolume max(FloatFlowVolume r1,
                                  FloatFlowVolume 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 FloatFlowVolume max(FloatFlowVolume r1,
                                  FloatFlowVolume r2,
                                  FloatFlowVolume... 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 FloatFlowVolume min(FloatFlowVolume r1,
                                  FloatFlowVolume 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 FloatFlowVolume min(FloatFlowVolume r1,
                                  FloatFlowVolume r2,
                                  FloatFlowVolume... 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 FloatFlowVolume valueOf(String text)
                               throws IllegalArgumentException

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

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(FloatFlowVolume v)

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

Parameters:

v - FloatFlowVolume scalar

Returns:

FloatDimensionless scalar as a division of FloatFlowVolume and FloatFlowVolume

multiplyBy

public final FloatVolume multiplyBy(FloatDuration v)

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

Parameters:

v - FloatFlowVolume scalar

Returns:

FloatVolume scalar as a multiplication of FloatFlowVolume and FloatDuration

divideBy

public final FloatVolume divideBy(FloatFrequency v)

Calculate the division of FloatFlowVolume and FloatFrequency, which results in a FloatVolume scalar.

Parameters:

v - FloatFlowVolume scalar

Returns:

FloatVolume scalar as a division of FloatFlowVolume and FloatFrequency

divideBy

public final FloatFrequency divideBy(FloatVolume v)

Calculate the division of FloatFlowVolume and FloatVolume, which results in a FloatFrequency scalar.

Parameters:

v - FloatFlowVolume scalar

Returns:

FloatFrequency scalar as a division of FloatFlowVolume and FloatVolume

divideBy

public final FloatSpeed divideBy(FloatArea v)

Calculate the division of FloatFlowVolume and FloatArea, which results in a FloatSpeed scalar.

Parameters:

v - FloatFlowVolume scalar

Returns:

FloatSpeed scalar as a division of FloatFlowVolume and FloatArea

divideBy

public final FloatArea divideBy(FloatSpeed v)

Calculate the division of FloatFlowVolume and FloatSpeed, which results in a FloatArea scalar.

Parameters:

v - FloatFlowVolume scalar

Returns:

FloatArea scalar as a division of FloatFlowVolume and FloatSpeed