org.djunits.value.vdouble.scalar

Class ElectricalCharge

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<ElectricalChargeUnit,ElectricalCharge>

org.djunits.value.vdouble.scalar.ElectricalCharge

All Implemented Interfaces:

Serializable, Comparable<ElectricalCharge>, MathFunctionsAbs<ElectricalCharge>, MathFunctionsRel<ElectricalCharge>, Relative, Value<ElectricalChargeUnit>, DoubleMathFunctions<ElectricalCharge>, DoubleScalarInterface

public class ElectricalCharge
extends AbstractDoubleScalarRel<ElectricalChargeUnit,ElectricalCharge>

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

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

we can now write:

 ElectricalCharge value = new ElectricalCharge(100.0, ElectricalChargeUnit.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 ElectricalCharge	NaN constant with value NaN.
static ElectricalCharge	NEG_MAXVALUE constant with value -MAX_VALUE.
static ElectricalCharge	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static ElectricalCharge	POS_MAXVALUE constant with value MAX_VALUE.
static ElectricalCharge	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static ElectricalCharge	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
ElectricalCharge(double value, ElectricalChargeUnit unit) Construct ElectricalCharge scalar.
ElectricalCharge(ElectricalCharge value) Construct ElectricalCharge scalar.

Method Summary

Modifier and Type	Method and Description
static ElectricalCharge	createSI(double value) Construct ElectricalCharge scalar.
ElectricalCurrent	divideBy(Duration v) Calculate the division of ElectricalCharge and Duration, which results in a ElectricalCurrent scalar.
Dimensionless	divideBy(ElectricalCharge v) Calculate the division of ElectricalCharge and ElectricalCharge, which results in a Dimensionless scalar.
Duration	divideBy(ElectricalCurrent v) Calculate the division of ElectricalCharge and ElectricalCurrent, which results in a Duration scalar.
ElectricalCharge	instantiateRel(double value, ElectricalChargeUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static ElectricalCharge	interpolate(ElectricalCharge zero, ElectricalCharge one, double ratio) Interpolate between two values.
static ElectricalCharge	max(ElectricalCharge r1, ElectricalCharge r2) Return the maximum value of two relative scalars.
static ElectricalCharge	max(ElectricalCharge r1, ElectricalCharge r2, ElectricalCharge... rn) Return the maximum value of more than two relative scalars.
static ElectricalCharge	min(ElectricalCharge r1, ElectricalCharge r2) Return the minimum value of two relative scalars.
static ElectricalCharge	min(ElectricalCharge r1, ElectricalCharge r2, ElectricalCharge... rn) Return the minimum value of more than two relative scalars.
static ElectricalCharge	valueOf(String text) Returns a ElectricalCharge 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 ElectricalCharge ZERO

constant with value zero.

NaN

public static final ElectricalCharge NaN

constant with value NaN.

POSITIVE_INFINITY

public static final ElectricalCharge POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final ElectricalCharge NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final ElectricalCharge POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final ElectricalCharge NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

ElectricalCharge

public ElectricalCharge(double value,
                        ElectricalChargeUnit unit)

Construct ElectricalCharge scalar.

Parameters:

value - double value

unit - unit for the double value

ElectricalCharge

public ElectricalCharge(ElectricalCharge value)

Construct ElectricalCharge scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final ElectricalCharge instantiateRel(double value,
                                             ElectricalChargeUnit unit)

Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateRel in class AbstractDoubleScalarRel<ElectricalChargeUnit,ElectricalCharge>

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 ElectricalCharge createSI(double value)

Construct ElectricalCharge scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

public static ElectricalCharge interpolate(ElectricalCharge zero,
                                           ElectricalCharge 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 ElectricalCharge max(ElectricalCharge r1,
                                   ElectricalCharge 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 ElectricalCharge max(ElectricalCharge r1,
                                   ElectricalCharge r2,
                                   ElectricalCharge... 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 ElectricalCharge min(ElectricalCharge r1,
                                   ElectricalCharge 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 ElectricalCharge min(ElectricalCharge r1,
                                   ElectricalCharge r2,
                                   ElectricalCharge... 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 ElectricalCharge valueOf(String text)
                                throws IllegalArgumentException

Returns a ElectricalCharge 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 ElectricalCharge

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(ElectricalCharge v)

Calculate the division of ElectricalCharge and ElectricalCharge, which results in a Dimensionless scalar.

Parameters:

v - ElectricalCharge scalar

Returns:

Dimensionless scalar as a division of ElectricalCharge and ElectricalCharge

divideBy

public final ElectricalCurrent divideBy(Duration v)

Calculate the division of ElectricalCharge and Duration, which results in a ElectricalCurrent scalar.

Parameters:

v - ElectricalCharge scalar

Returns:

ElectricalCurrent scalar as a division of ElectricalCharge and Duration

divideBy

public final Duration divideBy(ElectricalCurrent v)

Calculate the division of ElectricalCharge and ElectricalCurrent, which results in a Duration scalar.

Parameters:

v - ElectricalCharge scalar

Returns:

Duration scalar as a division of ElectricalCharge and ElectricalCurrent