org.djunits.value.vdouble.scalar

Class ElectricalCurrent

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vdouble.scalar.AbstractDoubleScalar<U,R>

org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel<ElectricalCurrentUnit,ElectricalCurrent>

org.djunits.value.vdouble.scalar.ElectricalCurrent

All Implemented Interfaces:

Serializable, Comparable<ElectricalCurrent>, MathFunctionsAbs<ElectricalCurrent>, MathFunctionsRel<ElectricalCurrent>, Relative, Value<ElectricalCurrentUnit>, DoubleMathFunctions<ElectricalCurrent>, DoubleScalarInterface

public class ElectricalCurrent
extends AbstractDoubleScalarRel<ElectricalCurrentUnit,ElectricalCurrent>

Easy access methods for the ElectricalCurrent DoubleScalar, which is relative by definition. Instead of:

 DoubleScalar.Rel<ElectricalCurrentUnit> value = new DoubleScalar.Rel<ElectricalCurrentUnit>(100.0, ElectricalCurrentUnit.SI);
 

we can now write:

 ElectricalCurrent value = new ElectricalCurrent(100.0, ElectricalCurrentUnit.SI);
 

The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit used are compatible.

Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2019-03-03 00:53:50 +0100 (Sun, 03 Mar 2019) $, @version $Revision: 349 $, by $Author: averbraeck $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ElectricalCurrent	NaN constant with value NaN.
static ElectricalCurrent	NEG_MAXVALUE constant with value -MAX_VALUE.
static ElectricalCurrent	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static ElectricalCurrent	POS_MAXVALUE constant with value MAX_VALUE.
static ElectricalCurrent	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static ElectricalCurrent	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors

Constructor and Description
ElectricalCurrent(double value, ElectricalCurrentUnit unit) Construct ElectricalCurrent scalar.
ElectricalCurrent(ElectricalCurrent value) Construct ElectricalCurrent scalar.

Method Summary

Modifier and Type	Method and Description
static ElectricalCurrent	createSI(double value) Construct ElectricalCurrent scalar.
Dimensionless	divideBy(ElectricalCurrent v) Calculate the division of ElectricalCurrent and ElectricalCurrent, which results in a Dimensionless scalar.
ElectricalCurrent	instantiateRel(double value, ElectricalCurrentUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static ElectricalCurrent	interpolate(ElectricalCurrent zero, ElectricalCurrent one, double ratio) Interpolate between two values.
static ElectricalCurrent	max(ElectricalCurrent r1, ElectricalCurrent r2) Return the maximum value of two relative scalars.
static ElectricalCurrent	max(ElectricalCurrent r1, ElectricalCurrent r2, ElectricalCurrent... rn) Return the maximum value of more than two relative scalars.
static ElectricalCurrent	min(ElectricalCurrent r1, ElectricalCurrent r2) Return the minimum value of two relative scalars.
static ElectricalCurrent	min(ElectricalCurrent r1, ElectricalCurrent r2, ElectricalCurrent... rn) Return the minimum value of more than two relative scalars.
ElectricalCharge	multiplyBy(Duration v) Calculate the multiplication of ElectricalCurrent and Duration, which results in a ElectricalCharge scalar.
Power	multiplyBy(ElectricalPotential v) Calculate the multiplication of ElectricalCurrent and ElectricalPotential, which results in a Power scalar.
ElectricalPotential	multiplyBy(ElectricalResistance v) Calculate the multiplication of ElectricalCurrent and ElectricalResistance, which results in a ElectricalPotential scalar.
static ElectricalCurrent	valueOf(String text) Returns a ElectricalCurrent representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel

abs, ceil, divideBy, floor, minus, multiplyBy, neg, plus, rint, round

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit, stringOf, stringOfDefaultLocale, textualStringOf, textualStringOfDefaultLocale

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final ElectricalCurrent ZERO

constant with value zero.

NaN

public static final ElectricalCurrent NaN

constant with value NaN.

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 value

unit - unit for the double value

ElectricalCurrent

public ElectricalCurrent(ElectricalCurrent value)

Construct ElectricalCurrent scalar.

Parameters:

value - 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.

Specified by:

instantiateRel in class AbstractDoubleScalarRel<ElectricalCurrentUnit,ElectricalCurrent>

Parameters:

value - double; the double value

unit - U; the unit

Returns:

R a new relative instance of the DoubleScalar of the right type

createSI

public static final ElectricalCurrent createSI(double value)

Construct ElectricalCurrent scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

public static ElectricalCurrent interpolate(ElectricalCurrent zero,
                                            ElectricalCurrent one,
                                            double ratio)

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - the ratio between 0 and 1, inclusive

Returns:

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 - the first scalar

r2 - the second scalar

Returns:

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 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

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 - the first scalar

r2 - the second scalar

Returns:

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 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the minimum value of more than two relative scalars

valueOf

public static ElectricalCurrent valueOf(String text)
                                 throws IllegalArgumentException

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 necessary, between the value and the unit.

Parameters:

text - String; the textual representation to parse into a ElectricalCurrent

Returns:

the String representation of the value in its unit, followed by the official abbreviation of the unit

Throws:

IllegalArgumentException - when the text cannot be parsed

divideBy

public final Dimensionless divideBy(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

multiplyBy

public final Power multiplyBy(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

multiplyBy

public final ElectricalCharge multiplyBy(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

multiplyBy

public final ElectricalPotential multiplyBy(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