Package org.djunits.value.vfloat.scalar

Class FloatElectricalPotential

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<ElectricalPotentialUnit,​FloatElectricalPotential>
org.djunits.value.vfloat.scalar.FloatElectricalPotential
All Implemented Interfaces:
Serializable, Cloneable, Comparable<FloatElectricalPotential>, Scalar<ElectricalPotentialUnit,​FloatElectricalPotential>, Scalar.Rel<ElectricalPotentialUnit,​FloatElectricalPotential>, ValueFunctions<ElectricalPotentialUnit,​FloatElectricalPotential>, Relative<ElectricalPotentialUnit,​FloatElectricalPotential>, Value<ElectricalPotentialUnit,​FloatElectricalPotential>, FloatScalarInterface<ElectricalPotentialUnit,​FloatElectricalPotential>, FloatScalarInterface.Rel<ElectricalPotentialUnit,​FloatElectricalPotential>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2020-01-19T15:21:24.964166400Z")
public class FloatElectricalPotential
extends AbstractFloatScalarRel<ElectricalPotentialUnit,​FloatElectricalPotential>
Easy access methods for the FloatElectricalPotential FloatScalar, 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

  • Constructor Details

  • Method Details

    • instantiateRel

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

    • interpolate

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

    • times

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

    • divide

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

    • divide

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

    • times

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