Package org.djunits.value.vdouble.scalar

Class ElectricalCharge

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

org.djunits.value.vdouble.scalar.ElectricalCharge

All Implemented Interfaces:

Serializable, Cloneable, Comparable<ElectricalCharge>, Relative<ElectricalChargeUnit,ElectricalCharge>, Value<ElectricalChargeUnit,ElectricalCharge>

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

Easy access methods for the ElectricalCharge 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 ElectricalCharge	NaN	Constant with value NaN.
static final ElectricalCharge	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final ElectricalCharge	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final ElectricalCharge	ONE	Constant with value one.
static final ElectricalCharge	POS_MAXVALUE	Constant with value MAX_VALUE.
static final ElectricalCharge	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final ElectricalCharge	ZERO	Constant with value zero.

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

si

Constructor Summary

Constructors

Constructor	Description
ElectricalCharge(double value, ElectricalChargeUnit unit)	Construct ElectricalCharge scalar.
ElectricalCharge(ElectricalCharge value)	Construct ElectricalCharge scalar.

Method Summary

Modifier and Type	Method	Description
final ElectricalCurrent	divide(Duration v)	Calculate the division of ElectricalCharge and Duration, which results in a ElectricalCurrent scalar.
final ElectricalPotential	divide(ElectricalCapacitance v)	Calculate the division of ElectricalCharge and ElectricalCapacitance, which results in a ElectricalPotential scalar.
final Dimensionless	divide(ElectricalCharge v)	Calculate the division of ElectricalCharge and ElectricalCharge, which results in a Dimensionless scalar.
final Duration	divide(ElectricalCurrent v)	Calculate the division of ElectricalCharge and ElectricalCurrent, which results in a Duration scalar.
final ElectricalCapacitance	divide(ElectricalPotential v)	Calculate the division of ElectricalCharge and ElectricalPotential, which results in a ElectricalCapacitance scalar.
final ElectricalCharge	instantiateRel(double value, ElectricalChargeUnit unit)	Construct a new Relative Immutable DoubleScalar of the right type.
static final ElectricalCharge	instantiateSI(double value)	Construct ElectricalCharge scalar.
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	of(double value, String unitString)	Returns a ElectricalCharge 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.
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.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 ElectricalCharge ZERO

Constant with value zero.

ONE

public static final ElectricalCharge ONE

Constant with value one.

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 Details

ElectricalCharge

public ElectricalCharge(double value,
 ElectricalChargeUnit unit)

Construct ElectricalCharge scalar.

Parameters:

value - double; the double value

unit - ElectricalChargeUnit; unit for the double value

ElectricalCharge

public ElectricalCharge(ElectricalCharge value)

Construct ElectricalCharge scalar.

Parameters:

value - ElectricalCharge; Scalar from which to construct this instance

Method Details

instantiateRel

public final ElectricalCharge instantiateRel(double value,
 ElectricalChargeUnit unit)

Description copied from class: DoubleScalarRel

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

Specified by:

instantiateRel in class DoubleScalarRel<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

instantiateSI

public static final ElectricalCharge instantiateSI(double value)

Construct ElectricalCharge scalar.

Parameters:

value - double; the double value in SI units

Returns:

ElectricalCharge; the new scalar with the SI value

interpolate

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

Interpolate between two values.

Parameters:

zero - ElectricalCharge; the low value

one - ElectricalCharge; the high value

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

Returns:

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

r2 - ElectricalCharge; the second scalar

Returns:

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

r2 - ElectricalCharge; the second scalar

rn - ElectricalCharge...; the other scalars

Returns:

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

r2 - ElectricalCharge; the second scalar

Returns:

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

r2 - ElectricalCharge; the second scalar

rn - ElectricalCharge...; the other scalars

Returns:

ElectricalCharge; the minimum value of more than two relative scalars

valueOf

public static ElectricalCharge valueOf(String text)

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

Returns:

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

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

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

divide

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

divide

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

divide

public final ElectricalCapacitance divide(ElectricalPotential v)

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

Parameters:

v - ElectricalCharge; scalar

Returns:

ElectricalCapacitance; scalar as a division of ElectricalCharge and ElectricalPotential

divide

public final ElectricalPotential divide(ElectricalCapacitance v)

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

Parameters:

v - ElectricalCharge; scalar

Returns:

ElectricalPotential; scalar as a division of ElectricalCharge and ElectricalCapacitance

reciprocal

public SIScalar reciprocal()

Description copied from class: DoubleScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class DoubleScalarRel<ElectricalChargeUnit,ElectricalCharge>

Returns:

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