Class FloatElectricalInductance

    • Constructor Detail

      • FloatElectricalInductance

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

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

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

      • instantiateRel

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

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

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