Class FloatElectricalCurrent

    • Constructor Detail

      • FloatElectricalCurrent

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

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

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

      • instantiateRel

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

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

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

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

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

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

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