Package org.djunits.value.vdouble.scalar

Class ElectricalConductance

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<ElectricalConductanceUnit,ElectricalConductance>

org.djunits.value.vdouble.scalar.ElectricalConductance

All Implemented Interfaces:

Serializable, Cloneable, Comparable<ElectricalConductance>, Relative<ElectricalConductanceUnit,ElectricalConductance>, Value<ElectricalConductanceUnit,ElectricalConductance>

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

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

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

si

Constructor Summary

Constructors

Constructor	Description
ElectricalConductance(double value, ElectricalConductanceUnit unit)	Construct ElectricalConductance scalar.
ElectricalConductance(ElectricalConductance value)	Construct ElectricalConductance scalar.

Method Summary

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

Constant with value zero.

ONE

public static final ElectricalConductance ONE

Constant with value one.

NaN

public static final ElectricalConductance NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final ElectricalConductance POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final ElectricalConductance NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final ElectricalConductance POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final ElectricalConductance NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

ElectricalConductance

public ElectricalConductance(double value,
 ElectricalConductanceUnit unit)

Construct ElectricalConductance scalar.

Parameters:

value - double; the double value

unit - ElectricalConductanceUnit; unit for the double value

ElectricalConductance

public ElectricalConductance(ElectricalConductance value)

Construct ElectricalConductance scalar.

Parameters:

value - ElectricalConductance; Scalar from which to construct this instance

Method Details

instantiateRel

public final ElectricalConductance instantiateRel(double value,
 ElectricalConductanceUnit unit)

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

Specified by:

instantiateRel in class DoubleScalarRel<ElectricalConductanceUnit,ElectricalConductance>

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

Construct ElectricalConductance scalar.

Parameters:

value - double; the double value in SI units

Returns:

ElectricalConductance; the new scalar with the SI value

interpolate

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

Interpolate between two values.

Parameters:

zero - ElectricalConductance; the low value

one - ElectricalConductance; the high value

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

Returns:

ElectricalConductance; a Scalar at the ratio between

max

public static ElectricalConductance max(ElectricalConductance r1,
 ElectricalConductance r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - ElectricalConductance; the first scalar

r2 - ElectricalConductance; the second scalar

Returns:

ElectricalConductance; the maximum value of two relative scalars

max

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

Return the maximum value of more than two relative scalars.

Parameters:

r1 - ElectricalConductance; the first scalar

r2 - ElectricalConductance; the second scalar

rn - ElectricalConductance...; the other scalars

Returns:

ElectricalConductance; the maximum value of more than two relative scalars

min

public static ElectricalConductance min(ElectricalConductance r1,
 ElectricalConductance r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - ElectricalConductance; the first scalar

r2 - ElectricalConductance; the second scalar

Returns:

ElectricalConductance; the minimum value of two relative scalars

min

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

Return the minimum value of more than two relative scalars.

Parameters:

r1 - ElectricalConductance; the first scalar

r2 - ElectricalConductance; the second scalar

rn - ElectricalConductance...; the other scalars

Returns:

ElectricalConductance; the minimum value of more than two relative scalars

valueOf

public static ElectricalConductance valueOf(String text)

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

Returns:

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

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

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

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

Parameters:

v - ElectricalConductance; scalar

Returns:

Dimensionless; scalar as a division of ElectricalConductance and ElectricalConductance

times

public final Dimensionless times(ElectricalResistance v)

Calculate the multiplication of ElectricalConductance and ElectricalResistance, which results in a Dimensionless scalar.

Parameters:

v - ElectricalConductance; scalar

Returns:

Dimensionless; scalar as a multiplication of ElectricalConductance and ElectricalResistance

times

public final ElectricalCurrent times(ElectricalPotential v)

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

Parameters:

v - ElectricalConductance; scalar

Returns:

ElectricalCurrent; scalar as a multiplication of ElectricalConductance and ElectricalPotential

times

public final ElectricalCapacitance times(Duration v)

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

Parameters:

v - ElectricalConductance; scalar

Returns:

ElectricalCapacitance; scalar as a multiplication of ElectricalConductance and Duration

reciprocal

public ElectricalResistance reciprocal()

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class DoubleScalarRel<ElectricalConductanceUnit,ElectricalConductance>

Returns:

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