Package org.djunits.value.vfloat.scalar

Class FloatMass

java.lang.Object
java.lang.Number
org.djunits.value.AbstractScalar<U,​S>
org.djunits.value.vfloat.scalar.base.AbstractFloatScalar<U,​R>
org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRel<MassUnit,​FloatMass>
org.djunits.value.vfloat.scalar.FloatMass
All Implemented Interfaces:
Serializable, Cloneable, Comparable<FloatMass>, Scalar<MassUnit,​FloatMass>, Scalar.Rel<MassUnit,​FloatMass>, ValueFunctions<MassUnit,​FloatMass>, Relative<MassUnit,​FloatMass>, Value<MassUnit,​FloatMass>, FloatScalarInterface<MassUnit,​FloatMass>, FloatScalarInterface.Rel<MassUnit,​FloatMass>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2019-10-18T12:12:25.568Z")
public class FloatMass
extends AbstractFloatScalarRel<MassUnit,​FloatMass>
Easy access methods for the FloatMass FloatScalar, 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

  • Field Details

  • Constructor Details

    • FloatMass

      public FloatMass​(float value, MassUnit unit)
      Construct FloatMass scalar.
      Parameters:
      value - float; the float value
      unit - unit for the float value

    • FloatMass

      public FloatMass​(FloatMass value)
      Construct FloatMass scalar.
      Parameters:
      value - Scalar from which to construct this instance

    • FloatMass

      public FloatMass​(double value, MassUnit unit)
      Construct FloatMass scalar using a double value.
      Parameters:
      value - double; the double value
      unit - unit for the resulting float value

  • Method Details

    • instantiateRel

      public final FloatMass instantiateRel​(float value, MassUnit unit)
      Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.
      Parameters:
      value - float; the float value
      unit - U; the unit
      Returns:
      R a new relative instance of the FloatScalar of the right type

    • instantiateSI

      public static final FloatMass instantiateSI​(float value)
      Construct FloatMass scalar.
      Parameters:
      value - float; the float value in SI units
      Returns:
      the new scalar with the SI value

    • interpolate

      public static FloatMass interpolate​(FloatMass zero, FloatMass one, float ratio)
      Interpolate between two values.
      Parameters:
      zero - the low value
      one - the high value
      ratio - double; the ratio between 0 and 1, inclusive
      Returns:
      a Scalar at the ratio between

    • max

      public static FloatMass max​(FloatMass r1, FloatMass 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 FloatMass max​(FloatMass r1, FloatMass r2, FloatMass... 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 FloatMass min​(FloatMass r1, FloatMass 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 FloatMass min​(FloatMass r1, FloatMass r2, FloatMass... 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 FloatMass valueOf​(String text)
      Returns a FloatMass 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 FloatMass
      Returns:
      FloatMass; the Scalar representation of the value in its unit
      Throws:
      IllegalArgumentException - when the text cannot be parsed
      NullPointerException - when the text argument is null

    • of

      public static FloatMass of​(float value, String unitString)
      Returns a FloatMass based on a value and the textual representation of the unit.
      Parameters:
      value - double; the value to use
      unitString - String; the textual representation of the unit
      Returns:
      FloatMass; the Scalar representation of the value in its unit
      Throws:
      IllegalArgumentException - when the unit cannot be parsed or is incorrect
      NullPointerException - when the unitString argument is null

    • divide

      public final FloatDimensionless divide​(FloatMass v)
      Calculate the division of FloatMass and FloatMass, which results in a FloatDimensionless scalar.
      Parameters:
      v - FloatMass scalar
      Returns:
      FloatDimensionless scalar as a division of FloatMass and FloatMass

    • divide

      public final FloatDuration divide​(FloatFlowMass v)
      Calculate the division of FloatMass and FloatFlowMass, which results in a FloatDuration scalar.
      Parameters:
      v - FloatMass scalar
      Returns:
      FloatDuration scalar as a division of FloatMass and FloatFlowMass

    • divide

      public final FloatFlowMass divide​(FloatDuration v)
      Calculate the division of FloatMass and FloatDuration, which results in a FloatFlowMass scalar.
      Parameters:
      v - FloatMass scalar
      Returns:
      FloatFlowMass scalar as a division of FloatMass and FloatDuration

    • times

      public final FloatForce times​(FloatAcceleration v)
      Calculate the multiplication of FloatMass and FloatAcceleration, which results in a FloatForce scalar.
      Parameters:
      v - FloatMass scalar
      Returns:
      FloatForce scalar as a multiplication of FloatMass and FloatAcceleration

    • times

      public final FloatFlowMass times​(FloatFrequency v)
      Calculate the multiplication of FloatMass and FloatFrequency, which results in a FloatFlowMass scalar.
      Parameters:
      v - FloatMass scalar
      Returns:
      FloatFlowMass scalar as a multiplication of FloatMass and FloatFrequency

    • divide

      public final FloatVolume divide​(FloatDensity v)
      Calculate the division of FloatMass and FloatDensity, which results in a FloatVolume scalar.
      Parameters:
      v - FloatMass scalar
      Returns:
      FloatVolume scalar as a division of FloatMass and FloatDensity

    • divide

      public final FloatDensity divide​(FloatVolume v)
      Calculate the division of FloatMass and FloatVolume, which results in a FloatDensity scalar.
      Parameters:
      v - FloatMass scalar
      Returns:
      FloatDensity scalar as a division of FloatMass and FloatVolume