Package org.djunits.value.vdouble.scalar

Class ElectricalCapacitance

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<ElectricalCapacitanceUnit,ElectricalCapacitance>

org.djunits.value.vdouble.scalar.ElectricalCapacitance

All Implemented Interfaces:

Serializable, Cloneable, Comparable<ElectricalCapacitance>, Relative<ElectricalCapacitanceUnit,ElectricalCapacitance>, Value<ElectricalCapacitanceUnit,ElectricalCapacitance>

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

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

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

si

Constructor Summary

Constructors

Constructor	Description
ElectricalCapacitance(double value, ElectricalCapacitanceUnit unit)	Construct ElectricalCapacitance scalar.
ElectricalCapacitance(ElectricalCapacitance value)	Construct ElectricalCapacitance scalar.

Method Summary

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

Constant with value zero.

ONE

public static final ElectricalCapacitance ONE

Constant with value one.

NaN

public static final ElectricalCapacitance NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final ElectricalCapacitance POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final ElectricalCapacitance NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final ElectricalCapacitance POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final ElectricalCapacitance NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

ElectricalCapacitance

public ElectricalCapacitance(double value,
 ElectricalCapacitanceUnit unit)

Construct ElectricalCapacitance scalar.

Parameters:

value - double; the double value

unit - ElectricalCapacitanceUnit; unit for the double value

ElectricalCapacitance

public ElectricalCapacitance(ElectricalCapacitance value)

Construct ElectricalCapacitance scalar.

Parameters:

value - ElectricalCapacitance; Scalar from which to construct this instance

Method Details

instantiateRel

public final ElectricalCapacitance instantiateRel(double value,
 ElectricalCapacitanceUnit 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<ElectricalCapacitanceUnit,ElectricalCapacitance>

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 ElectricalCapacitance instantiateSI(double value)

Construct ElectricalCapacitance scalar.

Parameters:

value - double; the double value in SI units

Returns:

ElectricalCapacitance; the new scalar with the SI value

interpolate

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

Interpolate between two values.

Parameters:

zero - ElectricalCapacitance; the low value

one - ElectricalCapacitance; the high value

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

Returns:

ElectricalCapacitance; a Scalar at the ratio between

max

public static ElectricalCapacitance max(ElectricalCapacitance r1,
 ElectricalCapacitance r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - ElectricalCapacitance; the first scalar

r2 - ElectricalCapacitance; the second scalar

Returns:

ElectricalCapacitance; the maximum value of two relative scalars

max

public static ElectricalCapacitance max(ElectricalCapacitance r1,
 ElectricalCapacitance r2,
 ElectricalCapacitance... rn)

Return the maximum value of more than two relative scalars.

Parameters:

r1 - ElectricalCapacitance; the first scalar

r2 - ElectricalCapacitance; the second scalar

rn - ElectricalCapacitance...; the other scalars

Returns:

ElectricalCapacitance; the maximum value of more than two relative scalars

min

public static ElectricalCapacitance min(ElectricalCapacitance r1,
 ElectricalCapacitance r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - ElectricalCapacitance; the first scalar

r2 - ElectricalCapacitance; the second scalar

Returns:

ElectricalCapacitance; the minimum value of two relative scalars

min

public static ElectricalCapacitance min(ElectricalCapacitance r1,
 ElectricalCapacitance r2,
 ElectricalCapacitance... rn)

Return the minimum value of more than two relative scalars.

Parameters:

r1 - ElectricalCapacitance; the first scalar

r2 - ElectricalCapacitance; the second scalar

rn - ElectricalCapacitance...; the other scalars

Returns:

ElectricalCapacitance; the minimum value of more than two relative scalars

valueOf

public static ElectricalCapacitance valueOf(String text)

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

Returns:

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

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

ElectricalCapacitance; 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(ElectricalCapacitance v)

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

Parameters:

v - ElectricalCapacitance; scalar

Returns:

Dimensionless; scalar as a division of ElectricalCapacitance and ElectricalCapacitance

times

public final ElectricalCharge times(ElectricalPotential v)

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

Parameters:

v - ElectricalCapacitance; scalar

Returns:

ElectricalCharge; scalar as a multiplication of ElectricalCapacitance and ElectricalPotential

divide

public final ElectricalConductance divide(Duration v)

Calculate the division of ElectricalCapacitance and Duration, which results in a ElectricalConductance scalar.

Parameters:

v - ElectricalCapacitance; scalar

Returns:

ElectricalConductance; scalar as a division of ElectricalCapacitance and Duration

divide

public final Duration divide(ElectricalConductance v)

Calculate the division of ElectricalCapacitance and ElectricalConductance, which results in a Duration scalar.

Parameters:

v - ElectricalCapacitance; scalar

Returns:

Duration; scalar as a division of ElectricalCapacitance and ElectricalConductance

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<ElectricalCapacitanceUnit,ElectricalCapacitance>

Returns:

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