Class FloatElectricalPotential

    • Constructor Detail

      • FloatElectricalPotential

        public FloatElectricalPotential​(float value,
                                        ElectricalPotentialUnit unit)
        Construct FloatElectricalPotential scalar.
        Parameters:
        value - float; the float value
        unit - unit for the float value
      • FloatElectricalPotential

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

        public FloatElectricalPotential​(double value,
                                        ElectricalPotentialUnit unit)
        Construct FloatElectricalPotential scalar using a double value.
        Parameters:
        value - double; the double value
        unit - unit for the resulting float value
    • Method Detail

      • 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
      • 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 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 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, which can be localized.
        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