Package org.djunits.value.vfloat.scalar

Class FloatTime

java.lang.Object
java.lang.Number
org.djunits.value.base.Scalar<U,S>
org.djunits.value.vfloat.scalar.base.FloatScalar<AU,A>
org.djunits.value.vfloat.scalar.base.FloatScalarAbs<TimeUnit,FloatTime,DurationUnit,FloatDuration>
org.djunits.value.vfloat.scalar.FloatTime
All Implemented Interfaces:
Serializable, Cloneable, Comparable<FloatTime>, Absolute<TimeUnit,FloatTime,DurationUnit,FloatDuration>, Value<TimeUnit,FloatTime>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2023-07-23T14:06:38.224104100Z") public class FloatTime extends FloatScalarAbs<TimeUnit,FloatTime,DurationUnit,FloatDuration>
Easy access methods for the FloatTime FloatScalar.

Note that when the offset of a stored absolute FloatTime becomes large, precision of a float might not be enough for the required resolution of a Time. A float has around 7 significant digits (23 bit mantissa). This means that when we need to have a float time that is precise to microseconds, the FloatTime value should not go above 2^22 = 4.0E6. This is not enough to store Epoch values that are in the order of magnitude of 2E12 ms! So feeding System.TimeInMillis() to a FloatTime with TimeUnit.BASE as its unit is not having the required precision. At best, a FloatTime can store TimeUnit.BASE or TimeUnit.EPOCH values with real calendar values with a precision of several minutes.

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 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)
      Description copied from class: FloatScalarAbs
      Construct a new Absolute Immutable FloatScalar of the right type. Each extending class must implement this method.
      Specified by:
      instantiateAbs in class FloatScalarAbs<TimeUnit,FloatTime,DurationUnit,FloatDuration>
      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)
      Description copied from class: FloatScalarAbs
      Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.
      Specified by:
      instantiateRel in class FloatScalarAbs<TimeUnit,FloatTime,DurationUnit,FloatDuration>
      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 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 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, which can be localized.
      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