Package org.djunits.value.vdouble.scalar
Class Mass
java.lang.Object
java.lang.Number
org.djunits.value.AbstractScalar<U,S>
org.djunits.value.vdouble.scalar.base.AbstractDoubleScalar<U,R>
org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel<MassUnit,Mass>
org.djunits.value.vdouble.scalar.Mass
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<Mass>
,Scalar<MassUnit,Mass>
,Scalar.Rel<MassUnit,Mass>
,ValueFunctions<MassUnit,Mass>
,Relative<MassUnit,Mass>
,Value<MassUnit,Mass>
,DoubleScalarInterface<MassUnit,Mass>
,DoubleScalarInterface.Rel<MassUnit,Mass>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2019-10-18T12:12:25.568Z") public class Mass extends AbstractDoubleScalarRel<MassUnit,Mass>
Easy access methods for the Mass DoubleScalar, which is relative by definition.
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.
- Author:
- Alexander Verbraeck, Peter Knoppers
- See Also:
- Serialized Form
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.djunits.value.vdouble.scalar.base.DoubleScalarInterface
DoubleScalarInterface.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends DoubleScalarInterface.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends DoubleScalarInterface.RelWithAbs<AU,A,RU,R>>, DoubleScalarInterface.Rel<U extends Unit<U>,R extends DoubleScalarInterface.Rel<U,R>>, DoubleScalarInterface.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends DoubleScalarInterface.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends DoubleScalarInterface.RelWithAbs<AU,A,RU,R>>
Nested classes/interfaces inherited from interface org.djunits.value.base.Scalar
Scalar.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends Scalar.RelWithAbs<AU,A,RU,R>>, Scalar.Rel<U extends Unit<U>,R extends Scalar.Rel<U,R>>, Scalar.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends Scalar.RelWithAbs<AU,A,RU,R>>
-
Field Summary
Fields Modifier and Type Field 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
ONE
Constant with value one.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. -
Constructor Summary
-
Method Summary
Modifier and Type Method Description Volume
divide(Density v)
Calculate the division of Mass and Density, which results in a Volume scalar.FlowMass
divide(Duration v)
Calculate the division of Mass and Duration, which results in a FlowMass scalar.Duration
divide(FlowMass v)
Calculate the division of Mass and FlowMass, which results in a Duration scalar.Dimensionless
divide(Mass v)
Calculate the division of Mass and Mass, which results in a Dimensionless scalar.Density
divide(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
instantiateSI(double value)
Construct Mass scalar.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.static Mass
of(double value, String unitString)
Returns a Mass based on a value and the textual representation of the unit.Force
times(Acceleration v)
Calculate the multiplication of Mass and Acceleration, which results in a Force scalar.FlowMass
times(Frequency v)
Calculate the multiplication of Mass and Frequency, which results in a FlowMass 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.base.AbstractDoubleScalarRel
abs, ceil, divide, divide, divide, floor, minus, neg, plus, reciprocal, rint, times, times, times
Methods inherited from class org.djunits.value.vdouble.scalar.base.AbstractDoubleScalar
clone, compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toDisplayString, toDisplayString, toString, toString, toString, toString, toTextualString, toTextualString
Methods inherited from class org.djunits.value.AbstractScalar
getDisplayUnit, isAbsolute, isRelative, setDisplayUnit
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.djunits.value.vdouble.scalar.base.DoubleScalarInterface
getInUnit, getInUnit, getSI
Methods inherited from interface org.djunits.value.base.Scalar
eq, eq0, ge, ge0, gt, gt0, le, le0, lt, lt0, ne, ne0, toDisplayString, toDisplayString, toTextualString, toTextualString
Methods inherited from interface org.djunits.value.Value
getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, toString, toString, toString, toString
-
Field Details
-
ZERO
Constant with value zero. -
ONE
Constant with value one. -
NaN
Constant with value NaN. -
POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY. -
NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY. -
POS_MAXVALUE
Constant with value MAX_VALUE. -
NEG_MAXVALUE
Constant with value -MAX_VALUE.
-
-
Constructor Details
-
Method Details
-
instantiateRel
Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.- Parameters:
value
- double; the double valueunit
- U; the unit- Returns:
- R a new relative instance of the DoubleScalar of the right type
-
instantiateSI
Construct Mass scalar.- Parameters:
value
- double; the double value in SI units- Returns:
- Mass; the new scalar with the SI value
-
interpolate
Interpolate between two values.- Parameters:
zero
- Mass; the low valueone
- Mass; the high valueratio
- double; the ratio between 0 and 1, inclusive- Returns:
- Mass; a Scalar at the ratio between
-
max
Return the maximum value of two relative scalars.- Parameters:
r1
- Mass; the first scalarr2
- Mass; the second scalar- Returns:
- Mass; the maximum value of two relative scalars
-
max
Return the maximum value of more than two relative scalars.- Parameters:
r1
- Mass; the first scalarr2
- Mass; the second scalarrn
- Mass...; the other scalars- Returns:
- Mass; the maximum value of more than two relative scalars
-
min
Return the minimum value of two relative scalars.- Parameters:
r1
- Mass; the first scalarr2
- Mass; the second scalar- Returns:
- Mass; the minimum value of two relative scalars
-
min
Return the minimum value of more than two relative scalars.- Parameters:
r1
- Mass; the first scalarr2
- Mass; the second scalarrn
- Mass...; the other scalars- Returns:
- Mass; the minimum value of more than two relative scalars
-
valueOf
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 required, between the value and the unit.- Parameters:
text
- String; the textual representation to parse into a Mass- Returns:
- Mass; the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException
- when the text cannot be parsedNullPointerException
- when the text argument is null
-
of
Returns a Mass based on a value and the textual representation of the unit.- Parameters:
value
- double; the value to useunitString
- String; the textual representation of the unit- Returns:
- Mass; the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException
- when the unit cannot be parsed or is incorrectNullPointerException
- when the unitString argument is null
-
divide
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
-
divide
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
-
divide
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
-
times
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
-
times
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
-
divide
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
-
divide
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
-