org.djunits.value.vdouble.scalar

Class Mass

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<MassUnit,Mass>

org.djunits.value.vdouble.scalar.Mass

All Implemented Interfaces:

Serializable, Comparable<Mass>, MathFunctionsAbs<Mass>, MathFunctionsRel<Mass>, Relative, Value<MassUnit>, DoubleMathFunctions<Mass>, DoubleScalarInterface

public class Mass
extends AbstractDoubleScalarRel<MassUnit,Mass>

Easy access methods for the Mass DoubleScalar, which is relative by definition. Instead of:

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

we can now write:

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

Method Summary

Modifier and Type	Method and Description
static Mass	createSI(double value) Construct Mass scalar.
Volume	divideBy(Density v) Calculate the division of Mass and Density, which results in a Volume scalar.
FlowMass	divideBy(Duration v) Calculate the division of Mass and Duration, which results in a FlowMass scalar.
Duration	divideBy(FlowMass v) Calculate the division of Mass and FlowMass, which results in a Duration scalar.
Dimensionless	divideBy(Mass v) Calculate the division of Mass and Mass, which results in a Dimensionless scalar.
Density	divideBy(Volume v) Calculate the division of Mass and Volume, which results in a Density scalar.
Mass	instantiateRel(double value, MassUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static Mass	interpolate(Mass zero, Mass one, double ratio) Interpolate between two values.
static Mass	max(Mass r1, Mass r2) Return the maximum value of two relative scalars.
static Mass	max(Mass r1, Mass r2, Mass... rn) Return the maximum value of more than two relative scalars.
static Mass	min(Mass r1, Mass r2) Return the minimum value of two relative scalars.
static Mass	min(Mass r1, Mass r2, Mass... rn) Return the minimum value of more than two relative scalars.
Force	multiplyBy(Acceleration v) Calculate the multiplication of Mass and Acceleration, which results in a Force scalar.
FlowMass	multiplyBy(Frequency v) Calculate the multiplication of Mass and Frequency, which results in a FlowMass scalar.
Money	multiplyBy(MoneyPerMass v) Calculate the multiplication of Mass and MoneyPerMass, which results in a Money scalar.
static Mass	valueOf(String text) Returns a Mass 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 Mass ZERO

constant with value zero.

NaN

public static final Mass NaN

constant with value NaN.

POSITIVE_INFINITY

public static final Mass POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Mass NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Mass POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Mass NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

Mass

public Mass(double value,
            MassUnit unit)

Construct Mass scalar.

Parameters:

value - double value

unit - unit for the double value

Mass

public Mass(Mass value)

Construct Mass scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final Mass instantiateRel(double value,
                                 MassUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<MassUnit,Mass>

Parameters:

value - double; the double value

unit - U; the unit

Returns:

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

createSI

public static final Mass createSI(double value)

Construct Mass scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

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

max

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

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

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

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

Parameters:

v - Mass scalar

Returns:

Dimensionless scalar as a division of Mass and Mass

divideBy

public final Duration divideBy(FlowMass v)

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

Parameters:

v - Mass scalar

Returns:

Duration scalar as a division of Mass and FlowMass

divideBy

public final FlowMass divideBy(Duration v)

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

Parameters:

v - Mass scalar

Returns:

FlowMass scalar as a division of Mass and Duration

multiplyBy

public final Force multiplyBy(Acceleration v)

Calculate the multiplication of Mass and Acceleration, which results in a Force scalar.

Parameters:

v - Mass scalar

Returns:

Force scalar as a multiplication of Mass and Acceleration

multiplyBy

public final FlowMass multiplyBy(Frequency v)

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

Parameters:

v - Mass scalar

Returns:

FlowMass scalar as a multiplication of Mass and Frequency

divideBy

public final Volume divideBy(Density v)

Calculate the division of Mass and Density, which results in a Volume scalar.

Parameters:

v - Mass scalar

Returns:

Volume scalar as a division of Mass and Density

divideBy

public final Density divideBy(Volume v)

Calculate the division of Mass and Volume, which results in a Density scalar.

Parameters:

v - Mass scalar

Returns:

Density scalar as a division of Mass and Volume

multiplyBy

public final Money multiplyBy(MoneyPerMass v)

Calculate the multiplication of Mass and MoneyPerMass, which results in a Money scalar.

Parameters:

v - Mass scalar

Returns:

Money scalar as a multiplication of Mass and MoneyPerMass