Class FloatElectricalCharge

    • Constructor Detail

      • FloatElectricalCharge

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

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

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

      • instantiateRel

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

        public static FloatElectricalCharge interpolate​(FloatElectricalCharge zero,
                                                        FloatElectricalCharge 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
      • valueOf

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

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

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

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

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