org.djunits.value.vdouble.scalar

Class Energy

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<EnergyUnit,Energy>

org.djunits.value.vdouble.scalar.Energy

All Implemented Interfaces:

Serializable, Comparable<Energy>, MathFunctionsAbs<Energy>, MathFunctionsRel<Energy>, Relative, Value<EnergyUnit>, DoubleMathFunctions<Energy>, DoubleScalarInterface

public class Energy
extends AbstractDoubleScalarRel<EnergyUnit,Energy>

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

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

we can now write:

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

Method Summary

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

constant with value zero.

NaN

public static final Energy NaN

constant with value NaN.

POSITIVE_INFINITY

public static final Energy POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Energy NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Energy POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Energy NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

Energy

public Energy(double value,
              EnergyUnit unit)

Construct Energy scalar.

Parameters:

value - double value

unit - unit for the double value

Energy

public Energy(Energy value)

Construct Energy scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final Energy instantiateRel(double value,
                                   EnergyUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<EnergyUnit,Energy>

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

Construct Energy scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - Energy scalar

Returns:

Dimensionless scalar as a division of Energy and Energy

divideBy

public final Length divideBy(Force v)

Calculate the division of Energy and Force, which results in a Length scalar.

Parameters:

v - Energy scalar

Returns:

Length scalar as a division of Energy and Force

divideBy

public final Force divideBy(Length v)

Calculate the division of Energy and Length, which results in a Force scalar.

Parameters:

v - Energy scalar

Returns:

Force scalar as a division of Energy and Length

multiplyBy

public final Force multiplyBy(LinearDensity v)

Calculate the multiplication of Energy and LinearDensity, which results in a Force scalar.

Parameters:

v - Energy scalar

Returns:

Force scalar as a multiplication of Energy and LinearDensity

divideBy

public final Power divideBy(Duration v)

Calculate the division of Energy and Duration, which results in a Power scalar.

Parameters:

v - Energy scalar

Returns:

Power scalar as a division of Energy and Duration

divideBy

public final Duration divideBy(Power v)

Calculate the division of Energy and Power, which results in a Duration scalar.

Parameters:

v - Energy scalar

Returns:

Duration scalar as a division of Energy and Power

divideBy

public final Pressure divideBy(Volume v)

Calculate the division of Energy and Volume, which results in a Pressure scalar.

Parameters:

v - Energy scalar

Returns:

Pressure scalar as a division of Energy and Volume

multiplyBy

public final Power multiplyBy(Frequency v)

Calculate the multiplication of Energy and Frequency, which results in a Power scalar.

Parameters:

v - Energy scalar

Returns:

Power scalar as a multiplication of Energy and Frequency

multiplyBy

public final Money multiplyBy(MoneyPerEnergy v)

Calculate the multiplication of Energy and MoneyPerEnergy, which results in a Money scalar.

Parameters:

v - Energy scalar

Returns:

Money scalar as a multiplication of Energy and MoneyPerEnergy