org.djunits.value.vfloat.scalar

Class FloatFlowMass

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<FlowMassUnit,FloatFlowMass>

org.djunits.value.vfloat.scalar.FloatFlowMass

All Implemented Interfaces:

Serializable, Comparable<FloatFlowMass>, MathFunctionsAbs<FloatFlowMass>, MathFunctionsRel<FloatFlowMass>, Relative, Value<FlowMassUnit>, FloatMathFunctions<FloatFlowMass>, FloatScalarInterface

public class FloatFlowMass
extends AbstractFloatScalarRel<FlowMassUnit,FloatFlowMass>

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

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

we can now write:

 FloatFlowMass value = new FloatFlowMass(100.0, FlowMassUnit.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 FloatFlowMass	NaN constant with value NaN.
static FloatFlowMass	NEG_MAXVALUE constant with value -MAX_VALUE.
static FloatFlowMass	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static FloatFlowMass	POS_MAXVALUE constant with value MAX_VALUE.
static FloatFlowMass	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static FloatFlowMass	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
FloatFlowMass(double value, FlowMassUnit unit) Construct FloatFlowMass scalar using a double value.
FloatFlowMass(FloatFlowMass value) Construct FloatFlowMass scalar.
FloatFlowMass(float value, FlowMassUnit unit) Construct FloatFlowMass scalar.

Method Summary

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

constant with value zero.

NaN

public static final FloatFlowMass NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatFlowMass POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatFlowMass NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatFlowMass POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatFlowMass NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatFlowMass

public FloatFlowMass(float value,
                     FlowMassUnit unit)

Construct FloatFlowMass scalar.

Parameters:

value - float value

unit - unit for the float value

FloatFlowMass

public FloatFlowMass(FloatFlowMass value)

Construct FloatFlowMass scalar.

Parameters:

value - Scalar from which to construct this instance

FloatFlowMass

public FloatFlowMass(double value,
                     FlowMassUnit unit)

Construct FloatFlowMass scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatFlowMass instantiateRel(float value,
                                          FlowMassUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<FlowMassUnit,FloatFlowMass>

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

Construct FloatFlowMass scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - FloatFlowMass scalar

Returns:

FloatDimensionless scalar as a division of FloatFlowMass and FloatFlowMass

multiplyBy

public final FloatMass multiplyBy(FloatDuration v)

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

Parameters:

v - FloatFlowMass scalar

Returns:

FloatMass scalar as a multiplication of FloatFlowMass and FloatDuration

divideBy

public final FloatMass divideBy(FloatFrequency v)

Calculate the division of FloatFlowMass and FloatFrequency, which results in a FloatMass scalar.

Parameters:

v - FloatFlowMass scalar

Returns:

FloatMass scalar as a division of FloatFlowMass and FloatFrequency

divideBy

public final FloatFrequency divideBy(FloatMass v)

Calculate the division of FloatFlowMass and FloatMass, which results in a FloatFrequency scalar.

Parameters:

v - FloatFlowMass scalar

Returns:

FloatFrequency scalar as a division of FloatFlowMass and FloatMass

multiplyBy

public final FloatForce multiplyBy(FloatSpeed v)

Calculate the multiplication of FloatFlowMass and FloatSpeed, which results in a FloatForce scalar.

Parameters:

v - FloatFlowMass scalar

Returns:

FloatForce scalar as a multiplication of FloatFlowMass and FloatSpeed