org.djunits.value.vfloat.scalar

Class FloatElectricalCurrent

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<ElectricalCurrentUnit,FloatElectricalCurrent>

org.djunits.value.vfloat.scalar.FloatElectricalCurrent

All Implemented Interfaces:

Serializable, Comparable<FloatElectricalCurrent>, MathFunctionsAbs<FloatElectricalCurrent>, MathFunctionsRel<FloatElectricalCurrent>, Relative, Value<ElectricalCurrentUnit>, FloatMathFunctions<FloatElectricalCurrent>, FloatScalarInterface

public class FloatElectricalCurrent
extends AbstractFloatScalarRel<ElectricalCurrentUnit,FloatElectricalCurrent>

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

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

we can now write:

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

Method Summary

Modifier and Type	Method and Description
static FloatElectricalCurrent	createSI(float value) Construct FloatElectricalCurrent scalar.
FloatDimensionless	divideBy(FloatElectricalCurrent v) Calculate the division of FloatElectricalCurrent and FloatElectricalCurrent, which results in a FloatDimensionless scalar.
FloatElectricalCurrent	instantiateRel(float value, ElectricalCurrentUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatElectricalCurrent	interpolate(FloatElectricalCurrent zero, FloatElectricalCurrent one, float ratio) Interpolate between two values.
static FloatElectricalCurrent	max(FloatElectricalCurrent r1, FloatElectricalCurrent r2) Return the maximum value of two relative scalars.
static FloatElectricalCurrent	max(FloatElectricalCurrent r1, FloatElectricalCurrent r2, FloatElectricalCurrent... rn) Return the maximum value of more than two relative scalars.
static FloatElectricalCurrent	min(FloatElectricalCurrent r1, FloatElectricalCurrent r2) Return the minimum value of two relative scalars.
static FloatElectricalCurrent	min(FloatElectricalCurrent r1, FloatElectricalCurrent r2, FloatElectricalCurrent... rn) Return the minimum value of more than two relative scalars.
FloatElectricalCharge	multiplyBy(FloatDuration v) Calculate the multiplication of FloatElectricalCurrent and FloatDuration, which results in a FloatElectricalCharge scalar.
FloatPower	multiplyBy(FloatElectricalPotential v) Calculate the multiplication of FloatElectricalCurrent and FloatElectricalPotential, which results in a FloatPower scalar.
FloatElectricalPotential	multiplyBy(FloatElectricalResistance v) Calculate the multiplication of FloatElectricalCurrent and FloatElectricalResistance, which results in a FloatElectricalPotential scalar.
static FloatElectricalCurrent	valueOf(String text) Returns a FloatElectricalCurrent 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 FloatElectricalCurrent ZERO

constant with value zero.

NaN

public static final FloatElectricalCurrent NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatElectricalCurrent POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatElectricalCurrent NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatElectricalCurrent POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatElectricalCurrent NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatElectricalCurrent

public FloatElectricalCurrent(float value,
                              ElectricalCurrentUnit unit)

Construct FloatElectricalCurrent scalar.

Parameters:

value - float value

unit - unit for the float value

FloatElectricalCurrent

public FloatElectricalCurrent(FloatElectricalCurrent value)

Construct FloatElectricalCurrent scalar.

Parameters:

value - Scalar from which to construct this instance

FloatElectricalCurrent

public FloatElectricalCurrent(double value,
                              ElectricalCurrentUnit unit)

Construct FloatElectricalCurrent scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatElectricalCurrent instantiateRel(float value,
                                                   ElectricalCurrentUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<ElectricalCurrentUnit,FloatElectricalCurrent>

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 FloatElectricalCurrent createSI(float value)

Construct FloatElectricalCurrent scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - FloatElectricalCurrent scalar

Returns:

FloatDimensionless scalar as a division of FloatElectricalCurrent and FloatElectricalCurrent

multiplyBy

public final FloatPower multiplyBy(FloatElectricalPotential v)

Calculate the multiplication of FloatElectricalCurrent and FloatElectricalPotential, which results in a FloatPower scalar.

Parameters:

v - FloatElectricalCurrent scalar

Returns:

FloatPower scalar as a multiplication of FloatElectricalCurrent and FloatElectricalPotential

multiplyBy

public final FloatElectricalCharge multiplyBy(FloatDuration v)

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

Parameters:

v - FloatElectricalCurrent scalar

Returns:

FloatElectricalCharge scalar as a multiplication of FloatElectricalCurrent and FloatDuration

multiplyBy

public final FloatElectricalPotential multiplyBy(FloatElectricalResistance v)

Calculate the multiplication of FloatElectricalCurrent and FloatElectricalResistance, which results in a FloatElectricalPotential scalar.

Parameters:

v - FloatElectricalCurrent scalar

Returns:

FloatElectricalPotential scalar as a multiplication of FloatElectricalCurrent and FloatElectricalResistance