Class FloatRadioActivity

    • Constructor Detail

      • FloatRadioActivity

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

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

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

      • instantiateRel

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

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