Package org.djunits.value.vdouble.scalar

Class ElectricalCurrent

    • Field Detail

      • POSITIVE_INFINITY

        public static final ElectricalCurrent POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final ElectricalCurrent NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final ElectricalCurrent POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final ElectricalCurrent NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • ElectricalCurrent

        public ElectricalCurrent​(double value,
                         ElectricalCurrentUnit unit)
        Construct ElectricalCurrent scalar.
        Parameters:
        value - double; the double value
        unit - ElectricalCurrentUnit; unit for the double value

      • ElectricalCurrent

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

    • Method Detail

      • instantiateRel

        public final ElectricalCurrent instantiateRel​(double value,
                                              ElectricalCurrentUnit unit)
        Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.
        Parameters:
        value - double; the double value
        unit - U; the unit
        Returns:
        R a new relative instance of the DoubleScalar of the right type

      • instantiateSI

        public static final ElectricalCurrent instantiateSI​(double value)
        Construct ElectricalCurrent scalar.
        Parameters:
        value - double; the double value in SI units
        Returns:
        ElectricalCurrent; the new scalar with the SI value

      • interpolate

        public static ElectricalCurrent interpolate​(ElectricalCurrent zero,
                                            ElectricalCurrent one,
                                            double ratio)
        Interpolate between two values.
        Parameters:
        zero - ElectricalCurrent; the low value
        one - ElectricalCurrent; the high value
        ratio - double; the ratio between 0 and 1, inclusive
        Returns:
        ElectricalCurrent; a Scalar at the ratio between

      • max

        public static ElectricalCurrent max​(ElectricalCurrent r1,
                                    ElectricalCurrent r2)
        Return the maximum value of two relative scalars.
        Parameters:
        r1 - ElectricalCurrent; the first scalar
        r2 - ElectricalCurrent; the second scalar
        Returns:
        ElectricalCurrent; the maximum value of two relative scalars

      • max

        public static ElectricalCurrent max​(ElectricalCurrent r1,
                                    ElectricalCurrent r2,
                                    ElectricalCurrent... rn)
        Return the maximum value of more than two relative scalars.
        Parameters:
        r1 - ElectricalCurrent; the first scalar
        r2 - ElectricalCurrent; the second scalar
        rn - ElectricalCurrent...; the other scalars
        Returns:
        ElectricalCurrent; the maximum value of more than two relative scalars

      • min

        public static ElectricalCurrent min​(ElectricalCurrent r1,
                                    ElectricalCurrent r2)
        Return the minimum value of two relative scalars.
        Parameters:
        r1 - ElectricalCurrent; the first scalar
        r2 - ElectricalCurrent; the second scalar
        Returns:
        ElectricalCurrent; the minimum value of two relative scalars

      • min

        public static ElectricalCurrent min​(ElectricalCurrent r1,
                                    ElectricalCurrent r2,
                                    ElectricalCurrent... rn)
        Return the minimum value of more than two relative scalars.
        Parameters:
        r1 - ElectricalCurrent; the first scalar
        r2 - ElectricalCurrent; the second scalar
        rn - ElectricalCurrent...; the other scalars
        Returns:
        ElectricalCurrent; the minimum value of more than two relative scalars

      • valueOf

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

      • times

        public final Power times​(ElectricalPotential v)
        Calculate the multiplication of ElectricalCurrent and ElectricalPotential, which results in a Power scalar.
        Parameters:
        v - ElectricalCurrent; scalar
        Returns:
        Power; scalar as a multiplication of ElectricalCurrent and ElectricalPotential

      • times

        public final ElectricalCharge times​(Duration v)
        Calculate the multiplication of ElectricalCurrent and Duration, which results in a ElectricalCharge scalar.
        Parameters:
        v - ElectricalCurrent; scalar
        Returns:
        ElectricalCharge; scalar as a multiplication of ElectricalCurrent and Duration

      • times

        public final ElectricalPotential times​(ElectricalResistance v)
        Calculate the multiplication of ElectricalCurrent and ElectricalResistance, which results in a ElectricalPotential scalar.
        Parameters:
        v - ElectricalCurrent; scalar
        Returns:
        ElectricalPotential; scalar as a multiplication of ElectricalCurrent and ElectricalResistance

      • divide

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

      • divide

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