Package org.djunits.value.vfloat.scalar

Class FloatAcceleration

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

    • FloatAcceleration

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

    • FloatAcceleration

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

    • FloatAcceleration

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

  • Method Details

    • instantiateRel

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

    • interpolate

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

    • times

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

    • times

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

    • divide

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

    • divide

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