org.djunits.value.vdouble.scalar

Class ElectricalResistance

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<ElectricalResistanceUnit,ElectricalResistance>

org.djunits.value.vdouble.scalar.ElectricalResistance

All Implemented Interfaces:

Serializable, Comparable<ElectricalResistance>, MathFunctionsAbs<ElectricalResistance>, MathFunctionsRel<ElectricalResistance>, Relative, Value<ElectricalResistanceUnit>, DoubleMathFunctions<ElectricalResistance>, DoubleScalarInterface

public class ElectricalResistance
extends AbstractDoubleScalarRel<ElectricalResistanceUnit,ElectricalResistance>

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

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

we can now write:

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

Method Summary

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

constant with value zero.

NaN

public static final ElectricalResistance NaN

constant with value NaN.

POSITIVE_INFINITY

public static final ElectricalResistance POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final ElectricalResistance NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final ElectricalResistance POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final ElectricalResistance NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

ElectricalResistance

public ElectricalResistance(double value,
                            ElectricalResistanceUnit unit)

Construct ElectricalResistance scalar.

Parameters:

value - double value

unit - unit for the double value

ElectricalResistance

public ElectricalResistance(ElectricalResistance value)

Construct ElectricalResistance scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final ElectricalResistance instantiateRel(double value,
                                                 ElectricalResistanceUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<ElectricalResistanceUnit,ElectricalResistance>

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

Construct ElectricalResistance scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - ElectricalResistance scalar

Returns:

Dimensionless scalar as a division of ElectricalResistance and ElectricalResistance

multiplyBy

public final ElectricalPotential multiplyBy(ElectricalCurrent v)

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

Parameters:

v - ElectricalResistance scalar

Returns:

ElectricalPotential scalar as a multiplication of ElectricalResistance and ElectricalCurrent