Package org.djunits.value.vfloat.scalar
Class FloatElectricalCharge
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<ElectricalChargeUnit,FloatElectricalCharge>
org.djunits.value.vfloat.scalar.FloatElectricalCharge
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<FloatElectricalCharge>
,Relative<ElectricalChargeUnit,
,FloatElectricalCharge> Value<ElectricalChargeUnit,
FloatElectricalCharge>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class FloatElectricalCharge
extends FloatScalarRel<ElectricalChargeUnit,FloatElectricalCharge>
Easy access methods for the FloatElectricalCharge 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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final FloatElectricalCharge
Constant with value NaN.static final FloatElectricalCharge
Constant with value -MAX_VALUE.static final FloatElectricalCharge
Constant with value NEGATIVE_INFINITY.static final FloatElectricalCharge
Constant with value one.static final FloatElectricalCharge
Constant with value MAX_VALUE.static final FloatElectricalCharge
Constant with value POSITIVE_INFINITY.static final FloatElectricalCharge
Constant with value zero.Fields inherited from class org.djunits.value.vfloat.scalar.base.FloatScalar
si
-
Constructor Summary
ConstructorDescriptionFloatElectricalCharge
(double value, ElectricalChargeUnit unit) Construct FloatElectricalCharge scalar using a double value.FloatElectricalCharge
(float value, ElectricalChargeUnit unit) Construct FloatElectricalCharge scalar.Construct FloatElectricalCharge scalar. -
Method Summary
Modifier and TypeMethodDescriptionfinal FloatElectricalCurrent
Calculate the division of FloatElectricalCharge and FloatDuration, which results in a FloatElectricalCurrent scalar.final FloatElectricalPotential
Calculate the division of FloatElectricalCharge and FloatElectricalCapacitance, which results in a FloatElectricalPotential scalar.final FloatDimensionless
Calculate the division of FloatElectricalCharge and FloatElectricalCharge, which results in a FloatDimensionless scalar.final FloatDuration
Calculate the division of FloatElectricalCharge and FloatElectricalCurrent, which results in a FloatDuration scalar.Calculate the division of FloatElectricalCharge and FloatElectricalPotential, which results in a FloatElectricalCapacitance scalar.final FloatElectricalCharge
instantiateRel
(float value, ElectricalChargeUnit unit) Construct a new Relative Immutable FloatScalar of the right type.static final FloatElectricalCharge
instantiateSI
(float value) Construct FloatElectricalCharge scalar.static FloatElectricalCharge
interpolate
(FloatElectricalCharge zero, FloatElectricalCharge one, float ratio) Interpolate between two values.static FloatElectricalCharge
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
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
Returns a FloatElectricalCharge based on a value and the textual representation of the unit, which can be localized.Create the reciprocal of this scalar with the correct dimensions.static FloatElectricalCharge
Returns a FloatElectricalCharge 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
Constant with value zero. -
ONE
Constant with value one. -
NaN
Constant with value NaN. -
POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY. -
NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY. -
POS_MAXVALUE
Constant with value MAX_VALUE. -
NEG_MAXVALUE
Constant with value -MAX_VALUE.
-
-
Constructor Details
-
FloatElectricalCharge
Construct FloatElectricalCharge scalar.- Parameters:
value
- float; the float valueunit
- unit for the float value
-
FloatElectricalCharge
Construct FloatElectricalCharge scalar.- Parameters:
value
- Scalar from which to construct this instance
-
FloatElectricalCharge
Construct FloatElectricalCharge scalar using a double value.- Parameters:
value
- double; the double valueunit
- unit for the resulting float value
-
-
Method Details
-
instantiateRel
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 classFloatScalarRel<ElectricalChargeUnit,
FloatElectricalCharge> - Parameters:
value
- float; the float valueunit
- U; the unit- Returns:
- R a new relative instance of the FloatScalar of the right type
-
instantiateSI
Construct FloatElectricalCharge scalar.- Parameters:
value
- float; the 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 valueone
- the high valueratio
- double; the ratio between 0 and 1, inclusive- Returns:
- a Scalar at the ratio between
-
max
Return the maximum value of two relative scalars.- Parameters:
r1
- the first scalarr2
- 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 scalarr2
- the second scalarrn
- the other scalars- Returns:
- the maximum value of more than two relative scalars
-
min
Return the minimum value of two relative scalars.- Parameters:
r1
- the first scalarr2
- 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 scalarr2
- the second scalarrn
- the other scalars- Returns:
- the minimum value of more than two relative scalars
-
valueOf
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 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 FloatElectricalCharge- Returns:
- FloatElectricalCharge; the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException
- when the text cannot be parsedNullPointerException
- when the text argument is null
-
of
Returns a FloatElectricalCharge based on a value and the textual representation of the unit, which can be localized.- Parameters:
value
- double; the value to useunitString
- String; the textual representation of the unit- Returns:
- FloatElectricalCharge; the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException
- when the unit cannot be parsed or is incorrectNullPointerException
- when the unitString argument is null
-
divide
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
-
divide
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
-
divide
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
-
divide
Calculate the division of FloatElectricalCharge and FloatElectricalPotential, which results in a FloatElectricalCapacitance scalar.- Parameters:
v
- FloatElectricalCharge; scalar- Returns:
- FloatElectricalCapacitance; scalar as a division of FloatElectricalCharge and FloatElectricalPotential
-
divide
Calculate the division of FloatElectricalCharge and FloatElectricalCapacitance, which results in a FloatElectricalPotential scalar.- Parameters:
v
- FloatElectricalCharge; scalar- Returns:
- FloatElectricalPotential; scalar as a division of FloatElectricalCharge and FloatElectricalCapacitance
-
reciprocal
Description copied from class:FloatScalarRel
Create the reciprocal of this scalar with the correct dimensions.- Specified by:
reciprocal
in classFloatScalarRel<ElectricalChargeUnit,
FloatElectricalCharge> - Returns:
- FloatScalar<?>; a new scalar instance with correct SI dimensions
-