Package org.djunits.value.vdouble.scalar
Class Mass
java.lang.Object
java.lang.Number
org.djunits.value.base.Scalar<U,S>
org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>
org.djunits.value.vdouble.scalar.base.DoubleScalarRel<MassUnit,Mass>
org.djunits.value.vdouble.scalar.Mass
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<Mass>
,Relative<MassUnit,
,Mass> Value<MassUnit,
Mass>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class Mass
extends DoubleScalarRel<MassUnit,Mass>
Easy access methods for the Mass DoubleScalar, which is relative by definition.
Copyright (c) 2013-2024 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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Mass
Constant with value NaN.static final Mass
Constant with value -MAX_VALUE.static final Mass
Constant with value NEGATIVE_INFINITY.static final Mass
Constant with value one.static final Mass
Constant with value MAX_VALUE.static final Mass
Constant with value POSITIVE_INFINITY.static final Mass
Constant with value zero.Fields inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar
si
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Volume
Calculate the division of Mass and Density, which results in a Volume scalar.final FlowMass
Calculate the division of Mass and Duration, which results in a FlowMass scalar.final Duration
Calculate the division of Mass and FlowMass, which results in a Duration scalar.final Dimensionless
Calculate the division of Mass and Mass, which results in a Dimensionless scalar.final Density
Calculate the division of Mass and Volume, which results in a Density scalar.final Mass
instantiateRel
(double value, MassUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.static final Mass
instantiateSI
(double value) Construct Mass scalar.static Mass
interpolate
(Mass zero, Mass one, double ratio) Interpolate between two values.static Mass
Return the maximum value of two relative scalars.static Mass
Return the maximum value of more than two relative scalars.static Mass
Return the minimum value of two relative scalars.static Mass
Return the minimum value of more than two relative scalars.static Mass
Returns a Mass based on a value and the textual representation of the unit, which can be localized.Create the reciprocal of this scalar with the correct dimensions.final Force
Calculate the multiplication of Mass and Acceleration, which results in a Force scalar.final FlowMass
Calculate the multiplication of Mass and Frequency, which results in a FlowMass scalar.final Momentum
Calculate the multiplication of Mass and Speed, which results in a Momentum scalar.toStringSIPrefixed
(int smallestPower, int biggestPower) Format this DoubleScalar in SI unit using prefixes when possible and within the specified size range.static Mass
Returns a Mass representation of a textual representation of a value with a unit.Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalarRel
abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times
Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar
compareTo, divide, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, instantiate, instantiateAnonymous, instantiateSI, interpolate, interpolate, intValue, le, le0, longValue, lt, lt0, max, max, min, min, minus, minus, minus, multiply, ne, ne0, plus, plus, plus, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toTextualString, toTextualString
Methods inherited from class org.djunits.value.base.Scalar
format, format, getDisplayUnit, setDisplayUnit
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.Value
isAbsolute, isRelative
-
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
-
Mass
Construct Mass scalar.- Parameters:
value
- double; the double valueunit
- MassUnit; unit for the double value
-
Mass
Construct Mass scalar.- Parameters:
value
- Mass; Scalar from which to construct this instance
-
-
Method Details
-
instantiateRel
Description copied from class:DoubleScalarRel
Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.- Specified by:
instantiateRel
in classDoubleScalarRel<MassUnit,
Mass> - 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 a localized or English 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, which can be localized.- 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
-
toStringSIPrefixed
Description copied from class:DoubleScalar
Format this DoubleScalar in SI unit using prefixes when possible and within the specified size range. If the value is too small or too large, e-notation and the plain SI unit are used.- Overrides:
toStringSIPrefixed
in classDoubleScalar<MassUnit,
Mass> - Parameters:
smallestPower
- int; the smallest exponent value that will be written using an SI prefixbiggestPower
- int; the largest exponent value that will be written using an SI prefix- Returns:
- String; formatted value of this DoubleScalar
-
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
-
times
Calculate the multiplication of Mass and Speed, which results in a Momentum scalar.- Parameters:
v
- Mass; scalar- Returns:
- Momentum; scalar as a multiplication of Mass and Speed
-
reciprocal
Description copied from class:DoubleScalarRel
Create the reciprocal of this scalar with the correct dimensions.- Specified by:
reciprocal
in classDoubleScalarRel<MassUnit,
Mass> - Returns:
- DoubleScalar<?>; a new scalar instance with correct SI dimensions
-