Package org.djunits.value.vfloat.scalar

Class FloatElectricalCurrent

java.lang.Object

java.lang.Number

org.djunits.value.base.Scalar<U,S>

org.djunits.value.vfloat.scalar.base.FloatScalar<U,R>

org.djunits.value.vfloat.scalar.base.FloatScalarRel<ElectricalCurrentUnit,FloatElectricalCurrent>

org.djunits.value.vfloat.scalar.FloatElectricalCurrent

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatElectricalCurrent>, Relative<ElectricalCurrentUnit,FloatElectricalCurrent>, Value<ElectricalCurrentUnit,FloatElectricalCurrent>

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

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

Fields inherited from class org.djunits.value.vfloat.scalar.base.FloatScalar

si

Constructor Summary

Constructors

Constructor	Description
FloatElectricalCurrent(double value, ElectricalCurrentUnit unit)	Construct FloatElectricalCurrent scalar using a double value.
FloatElectricalCurrent(float value, ElectricalCurrentUnit unit)	Construct FloatElectricalCurrent scalar.
FloatElectricalCurrent(FloatElectricalCurrent value)	Construct FloatElectricalCurrent scalar.

Method Summary

Modifier and Type	Method	Description
final FloatElectricalPotential	divide(FloatElectricalConductance v)	Calculate the division of FloatElectricalCurrent and FloatElectricalConductance, which results in a FloatElectricalPotential scalar.
final FloatDimensionless	divide(FloatElectricalCurrent v)	Calculate the division of FloatElectricalCurrent and FloatElectricalCurrent, which results in a FloatDimensionless scalar.
final FloatElectricalConductance	divide(FloatElectricalPotential v)	Calculate the division of FloatElectricalCurrent and FloatElectricalPotential, which results in a FloatElectricalConductance scalar.
final FloatElectricalCurrent	instantiateRel(float value, ElectricalCurrentUnit unit)	Construct a new Relative Immutable FloatScalar of the right type.
static final FloatElectricalCurrent	instantiateSI(float value)	Construct FloatElectricalCurrent scalar.
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.
static FloatElectricalCurrent	of(float value, String unitString)	Returns a FloatElectricalCurrent based on a value and the textual representation of the unit, which can be localized.
FloatSIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
final FloatElectricalCharge	times(FloatDuration v)	Calculate the multiplication of FloatElectricalCurrent and FloatDuration, which results in a FloatElectricalCharge scalar.
final FloatPower	times(FloatElectricalPotential v)	Calculate the multiplication of FloatElectricalCurrent and FloatElectricalPotential, which results in a FloatPower scalar.
final FloatElectricalPotential	times(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.base.FloatScalarRel

abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times

Methods inherited from class org.djunits.value.vfloat.scalar.base.FloatScalar

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 FloatElectricalCurrent ZERO

Constant with value zero.

ONE

public static final FloatElectricalCurrent ONE

Constant with value one.

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 Details

FloatElectricalCurrent

public FloatElectricalCurrent(float value,
 ElectricalCurrentUnit unit)

Construct FloatElectricalCurrent scalar.

Parameters:

value - float; the 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; the double value

unit - unit for the resulting float value

Method Details

instantiateRel

public final FloatElectricalCurrent instantiateRel(float value,
 ElectricalCurrentUnit unit)

Description copied from class: FloatScalarRel

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

Specified by:

instantiateRel in class FloatScalarRel<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

instantiateSI

public static final FloatElectricalCurrent instantiateSI(float value)

Construct FloatElectricalCurrent scalar.

Parameters:

value - float; the 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 - double; 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)

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

Returns:

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

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

FloatElectricalCurrent; 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 FloatDimensionless divide(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

times

public final FloatPower times(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

times

public final FloatElectricalCharge times(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

times

public final FloatElectricalPotential times(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

divide

public final FloatElectricalConductance divide(FloatElectricalPotential v)

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

Parameters:

v - FloatElectricalCurrent; scalar

Returns:

FloatElectricalConductance; scalar as a division of FloatElectricalCurrent and FloatElectricalPotential

divide

public final FloatElectricalPotential divide(FloatElectricalConductance v)

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

Parameters:

v - FloatElectricalCurrent; scalar

Returns:

FloatElectricalPotential; scalar as a division of FloatElectricalCurrent and FloatElectricalConductance

reciprocal

public FloatSIScalar reciprocal()

Description copied from class: FloatScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class FloatScalarRel<ElectricalCurrentUnit,FloatElectricalCurrent>

Returns:

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