org.djunits.value.vfloat.scalar

Class FloatElectricalCharge

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.AbstractFloatScalar<U,R>

org.djunits.value.vfloat.scalar.AbstractFloatScalarRel<ElectricalChargeUnit,FloatElectricalCharge>

org.djunits.value.vfloat.scalar.FloatElectricalCharge

All Implemented Interfaces:

Serializable, Comparable<FloatElectricalCharge>, MathFunctionsAbs<FloatElectricalCharge>, MathFunctionsRel<FloatElectricalCharge>, Relative, Value<ElectricalChargeUnit>, FloatMathFunctions<FloatElectricalCharge>, FloatScalarInterface

public class FloatElectricalCharge
extends AbstractFloatScalarRel<ElectricalChargeUnit,FloatElectricalCharge>

Easy access methods for the ElectricalCharge FloatScalar, which is relative by definition. An example is Speed. Instead of:

 FloatScalar.Rel<ElectricalChargeUnit> value = new FloatScalar.Rel<ElectricalChargeUnit>(100.0, ElectricalChargeUnit.SI);
 

we can now write:

 FloatElectricalCharge value = new FloatElectricalCharge(100.0, ElectricalChargeUnit.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 FloatElectricalCharge	NaN constant with value NaN.
static FloatElectricalCharge	NEG_MAXVALUE constant with value -MAX_VALUE.
static FloatElectricalCharge	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static FloatElectricalCharge	POS_MAXVALUE constant with value MAX_VALUE.
static FloatElectricalCharge	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static FloatElectricalCharge	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH, TO_DEGREES, TO_RADIANS

Constructor Summary

Constructors

Constructor and Description
FloatElectricalCharge(double value, ElectricalChargeUnit unit) Construct FloatElectricalCharge scalar using a double value.
FloatElectricalCharge(FloatElectricalCharge value) Construct FloatElectricalCharge scalar.
FloatElectricalCharge(float value, ElectricalChargeUnit unit) Construct FloatElectricalCharge scalar.

Method Summary

Modifier and Type	Method and Description
static FloatElectricalCharge	createSI(float value) Construct FloatElectricalCharge scalar.
FloatElectricalCurrent	divideBy(FloatDuration v) Calculate the division of FloatElectricalCharge and FloatDuration, which results in a FloatElectricalCurrent scalar.
FloatDimensionless	divideBy(FloatElectricalCharge v) Calculate the division of FloatElectricalCharge and FloatElectricalCharge, which results in a FloatDimensionless scalar.
FloatDuration	divideBy(FloatElectricalCurrent v) Calculate the division of FloatElectricalCharge and FloatElectricalCurrent, which results in a FloatDuration scalar.
FloatElectricalCharge	instantiateRel(float value, ElectricalChargeUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatElectricalCharge	interpolate(FloatElectricalCharge zero, FloatElectricalCharge one, float ratio) Interpolate between two values.
static FloatElectricalCharge	max(FloatElectricalCharge r1, FloatElectricalCharge r2) Return the maximum value of two relative scalars.
static FloatElectricalCharge	max(FloatElectricalCharge r1, FloatElectricalCharge r2, FloatElectricalCharge... rn) Return the maximum value of more than two relative scalars.
static FloatElectricalCharge	min(FloatElectricalCharge r1, FloatElectricalCharge r2) Return the minimum value of two relative scalars.
static FloatElectricalCharge	min(FloatElectricalCharge r1, FloatElectricalCharge r2, FloatElectricalCharge... rn) Return the minimum value of more than two relative scalars.
static FloatElectricalCharge	valueOf(String text) Returns a FloatElectricalCharge representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalarRel

abs, ceil, divideBy, floor, minus, multiplyBy, neg, plus, rint, round

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

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.vfloat.FloatMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final FloatElectricalCharge ZERO

constant with value zero.

NaN

public static final FloatElectricalCharge NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatElectricalCharge POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatElectricalCharge NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatElectricalCharge POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatElectricalCharge NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatElectricalCharge

public FloatElectricalCharge(float value,
                             ElectricalChargeUnit unit)

Construct FloatElectricalCharge scalar.

Parameters:

value - float value

unit - unit for the float value

FloatElectricalCharge

public FloatElectricalCharge(FloatElectricalCharge value)

Construct FloatElectricalCharge scalar.

Parameters:

value - Scalar from which to construct this instance

FloatElectricalCharge

public FloatElectricalCharge(double value,
                             ElectricalChargeUnit unit)

Construct FloatElectricalCharge scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatElectricalCharge instantiateRel(float value,
                                                  ElectricalChargeUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<ElectricalChargeUnit,FloatElectricalCharge>

Parameters:

value - float; the float value

unit - U; the unit

Returns:

R a new relative instance of the FloatScalar of the right type

createSI

public static final FloatElectricalCharge createSI(float value)

Construct FloatElectricalCharge scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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 FloatDimensionless divideBy(FloatElectricalCharge v)

Calculate the division of FloatElectricalCharge and FloatElectricalCharge, which results in a FloatDimensionless scalar.

Parameters:

v - FloatElectricalCharge scalar

Returns:

FloatDimensionless scalar as a division of FloatElectricalCharge and FloatElectricalCharge

divideBy

public final FloatElectricalCurrent divideBy(FloatDuration v)

Calculate the division of FloatElectricalCharge and FloatDuration, which results in a FloatElectricalCurrent scalar.

Parameters:

v - FloatElectricalCharge scalar

Returns:

FloatElectricalCurrent scalar as a division of FloatElectricalCharge and FloatDuration

divideBy

public final FloatDuration divideBy(FloatElectricalCurrent v)

Calculate the division of FloatElectricalCharge and FloatElectricalCurrent, which results in a FloatDuration scalar.

Parameters:

v - FloatElectricalCharge scalar

Returns:

FloatDuration scalar as a division of FloatElectricalCharge and FloatElectricalCurrent