Package org.djunits.value.vdouble.scalar

Class ElectricalPotential

java.lang.Object

java.lang.Number

org.djunits.value.base.Scalar<U,S>

org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>

org.djunits.value.vdouble.scalar.base.DoubleScalarRel<ElectricalPotentialUnit,ElectricalPotential>

org.djunits.value.vdouble.scalar.ElectricalPotential

All Implemented Interfaces:

Serializable, Cloneable, Comparable<ElectricalPotential>, Relative<ElectricalPotentialUnit,ElectricalPotential>, Value<ElectricalPotentialUnit,ElectricalPotential>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class ElectricalPotential
extends DoubleScalarRel<ElectricalPotentialUnit,ElectricalPotential>

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

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

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final ElectricalPotential	NaN	Constant with value NaN.
static final ElectricalPotential	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final ElectricalPotential	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final ElectricalPotential	ONE	Constant with value one.
static final ElectricalPotential	POS_MAXVALUE	Constant with value MAX_VALUE.
static final ElectricalPotential	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final ElectricalPotential	ZERO	Constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

si

Constructor Summary

Constructors

Constructor	Description
ElectricalPotential(double value, ElectricalPotentialUnit unit)	Construct ElectricalPotential scalar.
ElectricalPotential(ElectricalPotential value)	Construct ElectricalPotential scalar.

Method Summary

Modifier and Type	Method	Description
final ElectricalResistance	divide(ElectricalCurrent v)	Calculate the division of ElectricalPotential and ElectricalCurrent, which results in a ElectricalResistance scalar.
final Dimensionless	divide(ElectricalPotential v)	Calculate the division of ElectricalPotential and ElectricalPotential, which results in a Dimensionless scalar.
final ElectricalCurrent	divide(ElectricalResistance v)	Calculate the division of ElectricalPotential and ElectricalResistance, which results in a ElectricalCurrent scalar.
final ElectricalPotential	instantiateRel(double value, ElectricalPotentialUnit unit)	Construct a new Relative Immutable DoubleScalar of the right type.
static final ElectricalPotential	instantiateSI(double value)	Construct ElectricalPotential scalar.
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.
static ElectricalPotential	of(double value, String unitString)	Returns a ElectricalPotential based on a value and the textual representation of the unit, which can be localized.
SIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
final MagneticFlux	times(Duration v)	Calculate the multiplication of ElectricalPotential and Duration, which results in a MagneticFlux scalar.
final Power	times(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.base.DoubleScalarRel

abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

compareTo, divide, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, instantiate, instantiateAnonymous, instantiateSI, interpolate, interpolate, intValue, le, le0, longValue, lt, lt0, max, max, min, min, minus, minus, minus, multiply, ne, ne0, plus, plus, plus, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString

Methods inherited from class org.djunits.value.base.Scalar

format, format, getDisplayUnit, setDisplayUnit

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

isAbsolute, isRelative

Field Details

ZERO

public static final ElectricalPotential ZERO

Constant with value zero.

ONE

public static final ElectricalPotential ONE

Constant with value one.

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 Details

ElectricalPotential

public ElectricalPotential(double value,
 ElectricalPotentialUnit unit)

Construct ElectricalPotential scalar.

Parameters:

value - double; the double value

unit - ElectricalPotentialUnit; unit for the double value

ElectricalPotential

public ElectricalPotential(ElectricalPotential value)

Construct ElectricalPotential scalar.

Parameters:

value - ElectricalPotential; Scalar from which to construct this instance

Method Details

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 DoubleScalarRel<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

instantiateSI

public static final ElectricalPotential instantiateSI(double value)

Construct ElectricalPotential scalar.

Parameters:

value - double; the double value in SI units

Returns:

ElectricalPotential; the new scalar with the SI value

interpolate

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

Interpolate between two values.

Parameters:

zero - ElectricalPotential; the low value

one - ElectricalPotential; the high value

ratio - double; the ratio between 0 and 1, inclusive

Returns:

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

r2 - ElectricalPotential; the second scalar

Returns:

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

r2 - ElectricalPotential; the second scalar

rn - ElectricalPotential...; the other scalars

Returns:

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

r2 - ElectricalPotential; the second scalar

Returns:

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

r2 - ElectricalPotential; the second scalar

rn - ElectricalPotential...; the other scalars

Returns:

ElectricalPotential; the minimum value of more than two relative scalars

valueOf

public static ElectricalPotential valueOf(String text)

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 a localized or English 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 ElectricalPotential

Returns:

ElectricalPotential; 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 ElectricalPotential of(double value,
 String unitString)

Returns a ElectricalPotential based on a value and the textual representation of the unit, which can be localized.

Parameters:

value - double; the value to use

unitString - String; the textual representation of the unit

Returns:

ElectricalPotential; 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(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

times

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

divide

public final ElectricalResistance divide(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

divide

public final ElectricalCurrent divide(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

times

public final MagneticFlux times(Duration v)

Calculate the multiplication of ElectricalPotential and Duration, which results in a MagneticFlux scalar.

Parameters:

v - ElectricalPotential; scalar

Returns:

MagneticFlux; scalar as a multiplication of ElectricalPotential and Duration

reciprocal

public SIScalar reciprocal()

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class DoubleScalarRel<ElectricalPotentialUnit,ElectricalPotential>

Returns:

DoubleScalar<?>; a new scalar instance with correct SI dimensions