org.djunits.value.vdouble.scalar

Class ElectricalPotential

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<ElectricalPotentialUnit,ElectricalPotential>

org.djunits.value.vdouble.scalar.ElectricalPotential

All Implemented Interfaces:

Serializable, Comparable<ElectricalPotential>, MathFunctionsAbs<ElectricalPotential>, MathFunctionsRel<ElectricalPotential>, Relative, Value<ElectricalPotentialUnit>, DoubleMathFunctions<ElectricalPotential>, DoubleScalarInterface

public class ElectricalPotential
extends AbstractDoubleScalarRel<ElectricalPotentialUnit,ElectricalPotential>

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

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

we can now write:

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

Method Summary

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

constant with value zero.

NaN

public static final ElectricalPotential NaN

constant with value NaN.

POSITIVE_INFINITY

public static final ElectricalPotential POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final ElectricalPotential NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final ElectricalPotential POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final ElectricalPotential NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

ElectricalPotential

public ElectricalPotential(double value,
                           ElectricalPotentialUnit unit)

Construct ElectricalPotential scalar.

Parameters:

value - double value

unit - unit for the double value

ElectricalPotential

public ElectricalPotential(ElectricalPotential value)

Construct ElectricalPotential scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final ElectricalPotential instantiateRel(double value,
                                                ElectricalPotentialUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<ElectricalPotentialUnit,ElectricalPotential>

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

Construct ElectricalPotential scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - ElectricalPotential scalar

Returns:

Dimensionless scalar as a division of ElectricalPotential and ElectricalPotential

multiplyBy

public final Power multiplyBy(ElectricalCurrent v)

Calculate the multiplication of ElectricalPotential and ElectricalCurrent, which results in a Power scalar.

Parameters:

v - ElectricalPotential scalar

Returns:

Power scalar as a multiplication of ElectricalPotential and ElectricalCurrent

divideBy

public final ElectricalResistance divideBy(ElectricalCurrent v)

Calculate the division of ElectricalPotential and ElectricalCurrent, which results in a ElectricalResistance scalar.

Parameters:

v - ElectricalPotential scalar

Returns:

ElectricalResistance scalar as a division of ElectricalPotential and ElectricalCurrent

divideBy

public final ElectricalCurrent divideBy(ElectricalResistance v)

Calculate the division of ElectricalPotential and ElectricalResistance, which results in a ElectricalCurrent scalar.

Parameters:

v - ElectricalPotential scalar

Returns:

ElectricalCurrent scalar as a division of ElectricalPotential and ElectricalResistance