Package org.djunits.value.vfloat.scalar

Class FloatMagneticFlux

    • Field Detail

      • POSITIVE_INFINITY

        public static final FloatMagneticFlux POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final FloatMagneticFlux NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final FloatMagneticFlux POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final FloatMagneticFlux NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • FloatMagneticFlux

        public FloatMagneticFlux​(float value,
                         MagneticFluxUnit unit)
        Construct FloatMagneticFlux scalar.
        Parameters:
        value - float; the float value
        unit - unit for the float value

      • FloatMagneticFlux

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

      • FloatMagneticFlux

        public FloatMagneticFlux​(double value,
                         MagneticFluxUnit unit)
        Construct FloatMagneticFlux scalar using a double value.
        Parameters:
        value - double; the double value
        unit - unit for the resulting float value

    • Method Detail

      • instantiateRel

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

      • interpolate

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

      • divide

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

      • divide

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

      • divide

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

      • divide

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

      • divide

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

      • divide

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