Package org.djunits.value.vdouble.scalar

Class Torque

java.lang.Object
java.lang.Number
org.djunits.value.AbstractScalar<U,​S>
org.djunits.value.vdouble.scalar.base.AbstractDoubleScalar<U,​R>
org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel<TorqueUnit,​Torque>
org.djunits.value.vdouble.scalar.Torque
All Implemented Interfaces:
Serializable, Cloneable, Comparable<Torque>, Scalar<TorqueUnit,​Torque>, Scalar.Rel<TorqueUnit,​Torque>, ValueFunctions<TorqueUnit,​Torque>, Relative<TorqueUnit,​Torque>, Value<TorqueUnit,​Torque>, DoubleScalarInterface<TorqueUnit,​Torque>, DoubleScalarInterface.Rel<TorqueUnit,​Torque>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2020-01-19T15:21:24.964166400Z")
public class Torque
extends AbstractDoubleScalarRel<TorqueUnit,​Torque>
Easy access methods for the Torque DoubleScalar, which is relative by definition.

Copyright (c) 2013-2020 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

    • ZERO

      public static final Torque ZERO
      Constant with value zero.

    • ONE

      public static final Torque ONE
      Constant with value one.

    • NaN

      public static final Torque NaN
      Constant with value NaN.

    • POSITIVE_INFINITY

      public static final Torque POSITIVE_INFINITY
      Constant with value POSITIVE_INFINITY.

    • NEGATIVE_INFINITY

      public static final Torque NEGATIVE_INFINITY
      Constant with value NEGATIVE_INFINITY.

    • POS_MAXVALUE

      public static final Torque POS_MAXVALUE
      Constant with value MAX_VALUE.

    • NEG_MAXVALUE

      public static final Torque NEG_MAXVALUE
      Constant with value -MAX_VALUE.

  • Constructor Details

    • Torque

      public Torque​(double value, TorqueUnit unit)
      Construct Torque scalar.
      Parameters:
      value - double; the double value
      unit - TorqueUnit; unit for the double value

    • Torque

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

  • Method Details

    • instantiateRel

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

    • instantiateSI

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

    • interpolate

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

    • max

      public static Torque max​(Torque r1, Torque r2)
      Return the maximum value of two relative scalars.
      Parameters:
      r1 - Torque; the first scalar
      r2 - Torque; the second scalar
      Returns:
      Torque; the maximum value of two relative scalars

    • max

      public static Torque max​(Torque r1, Torque r2, Torque... rn)
      Return the maximum value of more than two relative scalars.
      Parameters:
      r1 - Torque; the first scalar
      r2 - Torque; the second scalar
      rn - Torque...; the other scalars
      Returns:
      Torque; the maximum value of more than two relative scalars

    • min

      public static Torque min​(Torque r1, Torque r2)
      Return the minimum value of two relative scalars.
      Parameters:
      r1 - Torque; the first scalar
      r2 - Torque; the second scalar
      Returns:
      Torque; the minimum value of two relative scalars

    • min

      public static Torque min​(Torque r1, Torque r2, Torque... rn)
      Return the minimum value of more than two relative scalars.
      Parameters:
      r1 - Torque; the first scalar
      r2 - Torque; the second scalar
      rn - Torque...; the other scalars
      Returns:
      Torque; the minimum value of more than two relative scalars

    • valueOf

      public static Torque valueOf​(String text)
      Returns a Torque 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 Torque
      Returns:
      Torque; 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 Torque of​(double value, String unitString)
      Returns a Torque 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:
      Torque; 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 Dimensionless divide​(Torque v)
      Calculate the division of Torque and Torque, which results in a Dimensionless scalar.
      Parameters:
      v - Torque scalar
      Returns:
      Dimensionless scalar as a division of Torque and Torque

    • divide

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

    • divide

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

    • times

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

    • divide

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

    • divide

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

    • times

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

    • divide

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

    • divide

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