Package org.djunits.value.vfloat.scalar

Class FloatArea

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<AreaUnit,​FloatArea>
org.djunits.value.vfloat.scalar.FloatArea
All Implemented Interfaces:
Serializable, Cloneable, Comparable<FloatArea>, Scalar<AreaUnit,​FloatArea>, Scalar.Rel<AreaUnit,​FloatArea>, ValueFunctions<AreaUnit,​FloatArea>, Relative<AreaUnit,​FloatArea>, Value<AreaUnit,​FloatArea>, FloatScalarInterface<AreaUnit,​FloatArea>, FloatScalarInterface.Rel<AreaUnit,​FloatArea>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2019-10-18T12:12:25.568Z")
public class FloatArea
extends AbstractFloatScalarRel<AreaUnit,​FloatArea>
Easy access methods for the FloatArea 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

    • FloatArea

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

    • FloatArea

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

    • FloatArea

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

  • Method Details

    • instantiateRel

      public final FloatArea instantiateRel​(float value, AreaUnit 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 FloatArea instantiateSI​(float value)
      Construct FloatArea scalar.
      Parameters:
      value - float; the float value in SI units
      Returns:
      the new scalar with the SI value

    • interpolate

      public static FloatArea interpolate​(FloatArea zero, FloatArea 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 FloatArea max​(FloatArea r1, FloatArea 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 FloatArea max​(FloatArea r1, FloatArea r2, FloatArea... 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 FloatArea min​(FloatArea r1, FloatArea 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 FloatArea min​(FloatArea r1, FloatArea r2, FloatArea... 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 FloatArea valueOf​(String text)
      Returns a FloatArea 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 FloatArea
      Returns:
      FloatArea; 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 FloatArea of​(float value, String unitString)
      Returns a FloatArea 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:
      FloatArea; 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​(FloatArea v)
      Calculate the division of FloatArea and FloatArea, which results in a FloatDimensionless scalar.
      Parameters:
      v - FloatArea scalar
      Returns:
      FloatDimensionless scalar as a division of FloatArea and FloatArea

    • times

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

    • divide

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

    • divide

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

    • divide

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

    • times

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

    • times

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

    • times

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

    • times

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