Package org.djunits.value.vfloat.scalar

Class FloatTime

java.lang.Object
java.lang.Number
org.djunits.value.AbstractScalar<U,​S>
org.djunits.value.vfloat.scalar.base.AbstractFloatScalar<AU,​A>
org.djunits.value.vfloat.scalar.base.AbstractFloatScalarAbs<TimeUnit,​FloatTime,​DurationUnit,​FloatDuration>
org.djunits.value.vfloat.scalar.FloatTime
All Implemented Interfaces:
Serializable, Cloneable, Comparable<FloatTime>, Absolute, Scalar<TimeUnit,​FloatTime>, Scalar.Abs<TimeUnit,​FloatTime,​DurationUnit,​FloatDuration>, ValueFunctions<TimeUnit,​FloatTime>, Value<TimeUnit,​FloatTime>, FloatScalarInterface<TimeUnit,​FloatTime>, FloatScalarInterface.Abs<TimeUnit,​FloatTime,​DurationUnit,​FloatDuration>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2020-01-19T15:21:24.964166400Z")
public class FloatTime
extends AbstractFloatScalarAbs<TimeUnit,​FloatTime,​DurationUnit,​FloatDuration>
Easy access methods for the FloatTime FloatScalar.

Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands.
All rights reserved.
BSD-style license. See OpenTrafficSim License.

Author:
Alexander Verbraeck, Peter Knoppers
See Also:
Serialized Form

  • Field Details

    • ZERO

      public static final FloatTime ZERO
      Constant with value zero.

  • Constructor Details

    • FloatTime

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

    • FloatTime

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

    • FloatTime

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

  • Method Details

    • instantiateAbs

      public final FloatTime instantiateAbs​(float value, TimeUnit unit)
      Construct a new Absolute Immutable FloatScalar of the right type. Each extending class must implement this method.
      Parameters:
      value - float; the float value
      unit - AU; the absolute unit
      Returns:
      A a new absolute instance of the FloatScalar of the right type

    • instantiateRel

      public final FloatDuration instantiateRel​(float value, DurationUnit 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 - RU; the unit
      Returns:
      R a new relative instance of the FloatScalar of the right type

    • instantiateSI

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

    • interpolate

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

    • max

      public static FloatTime max​(FloatTime a1, FloatTime a2)
      Return the maximum value of two absolute scalars.
      Parameters:
      a1 - FloatTime; the first scalar
      a2 - FloatTime; the second scalar
      Returns:
      FloatTime; the maximum value of two absolute scalars

    • max

      public static FloatTime max​(FloatTime a1, FloatTime a2, FloatTime... an)
      Return the maximum value of more than two absolute scalars.
      Parameters:
      a1 - FloatTime; the first scalar
      a2 - FloatTime; the second scalar
      an - FloatTime...; the other scalars
      Returns:
      FloatTime; the maximum value of more than two absolute scalars

    • min

      public static FloatTime min​(FloatTime a1, FloatTime a2)
      Return the minimum value of two absolute scalars.
      Parameters:
      a1 - FloatTime; the first scalar
      a2 - FloatTime; the second scalar
      Returns:
      FloatTime; the minimum value of two absolute scalars

    • min

      public static FloatTime min​(FloatTime a1, FloatTime a2, FloatTime... an)
      Return the minimum value of more than two absolute scalars.
      Parameters:
      a1 - FloatTime; the first scalar
      a2 - FloatTime; the second scalar
      an - FloatTime...; the other scalars
      Returns:
      FloatTime; the minimum value of more than two absolute scalars

    • valueOf

      public static FloatTime valueOf​(String text)
      Returns a FloatTime 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 FloatTime
      Returns:
      FloatTime; 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 FloatTime of​(float value, String unitString)
      Returns a FloatTime 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:
      FloatTime; 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