Package org.djunits.value.vfloat.scalar
Class FloatElectricalCharge
- java.lang.Object
-
- java.lang.Number
-
- org.djunits.value.AbstractScalar<U,S>
-
- org.djunits.value.vfloat.scalar.base.AbstractFloatScalar<U,R>
-
- org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRel<ElectricalChargeUnit,FloatElectricalCharge>
-
- org.djunits.value.vfloat.scalar.FloatElectricalCharge
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<FloatElectricalCharge>
,Scalar<ElectricalChargeUnit,FloatElectricalCharge>
,Scalar.Rel<ElectricalChargeUnit,FloatElectricalCharge>
,ValueFunctions<ElectricalChargeUnit,FloatElectricalCharge>
,Relative<ElectricalChargeUnit,FloatElectricalCharge>
,Value<ElectricalChargeUnit,FloatElectricalCharge>
,FloatScalarInterface<ElectricalChargeUnit,FloatElectricalCharge>
,FloatScalarInterface.Rel<ElectricalChargeUnit,FloatElectricalCharge>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2020-01-19T15:21:24.964166400Z") public class FloatElectricalCharge extends AbstractFloatScalarRel<ElectricalChargeUnit,FloatElectricalCharge>
Easy access methods for the FloatElectricalCharge FloatScalar, which is relative by definition.Copyright (c) 2013-2020 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
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.djunits.value.vfloat.scalar.base.FloatScalarInterface
FloatScalarInterface.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarInterface.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends FloatScalarInterface.RelWithAbs<AU,A,RU,R>>, FloatScalarInterface.Rel<U extends Unit<U>,R extends FloatScalarInterface.Rel<U,R>>, FloatScalarInterface.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarInterface.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends FloatScalarInterface.RelWithAbs<AU,A,RU,R>>
-
Nested classes/interfaces inherited from interface org.djunits.value.base.Scalar
Scalar.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends Scalar.RelWithAbs<AU,A,RU,R>>, Scalar.Rel<U extends Unit<U>,R extends Scalar.Rel<U,R>>, Scalar.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends Scalar.RelWithAbs<AU,A,RU,R>>
-
-
Field Summary
Fields Modifier and Type Field 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
ONE
Constant with value one.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.base.AbstractFloatScalar
si
-
-
Constructor Summary
Constructors Constructor Description FloatElectricalCharge(double value, ElectricalChargeUnit unit)
Construct FloatElectricalCharge scalar using a double value.FloatElectricalCharge(float value, ElectricalChargeUnit unit)
Construct FloatElectricalCharge scalar.FloatElectricalCharge(FloatElectricalCharge value)
Construct FloatElectricalCharge scalar.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FloatElectricalCurrent
divide(FloatDuration v)
Calculate the division of FloatElectricalCharge and FloatDuration, which results in a FloatElectricalCurrent scalar.FloatElectricalPotential
divide(FloatElectricalCapacitance v)
Calculate the division of FloatElectricalCharge and FloatElectricalCapacitance, which results in a FloatElectricalPotential scalar.FloatDimensionless
divide(FloatElectricalCharge v)
Calculate the division of FloatElectricalCharge and FloatElectricalCharge, which results in a FloatDimensionless scalar.FloatDuration
divide(FloatElectricalCurrent v)
Calculate the division of FloatElectricalCharge and FloatElectricalCurrent, which results in a FloatDuration scalar.FloatElectricalCapacitance
divide(FloatElectricalPotential v)
Calculate the division of FloatElectricalCharge and FloatElectricalPotential, which results in a FloatElectricalCapacitance scalar.FloatElectricalCharge
instantiateRel(float value, ElectricalChargeUnit unit)
Construct a new Relative Immutable FloatScalar of the right type.static FloatElectricalCharge
instantiateSI(float value)
Construct FloatElectricalCharge scalar.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
of(float value, String unitString)
Returns a FloatElectricalCharge based on a value and the textual representation of the unit.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.base.AbstractFloatScalarRel
abs, ceil, divide, divide, divide, floor, minus, neg, plus, reciprocal, rint, times, times, times
-
Methods inherited from class org.djunits.value.vfloat.scalar.base.AbstractFloatScalar
compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toDisplayString, toDisplayString, toString, toString, toString, toString, toTextualString, toTextualString
-
Methods inherited from class org.djunits.value.AbstractScalar
getDisplayUnit, isAbsolute, isRelative, 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 java.lang.Comparable
compareTo
-
Methods inherited from interface org.djunits.value.vfloat.scalar.base.FloatScalarInterface
getInUnit, getInUnit, getSI
-
Methods inherited from interface org.djunits.value.base.Scalar
eq, eq0, ge, ge0, gt, gt0, le, le0, lt, lt0, ne, ne0, toDisplayString, toDisplayString, toTextualString, toTextualString
-
Methods inherited from interface org.djunits.value.Value
getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, toString, toString, toString, toString
-
-
-
-
Field Detail
-
ZERO
public static final FloatElectricalCharge ZERO
Constant with value zero.
-
ONE
public static final FloatElectricalCharge ONE
Constant with value one.
-
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; the float valueunit
- 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; the double valueunit
- 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.- Parameters:
value
- float; the float valueunit
- U; the unit- Returns:
- R a new relative instance of the FloatScalar of the right type
-
instantiateSI
public static final FloatElectricalCharge instantiateSI(float value)
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
public static FloatElectricalCharge max(FloatElectricalCharge r1, FloatElectricalCharge r2)
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
public static FloatElectricalCharge min(FloatElectricalCharge r1, FloatElectricalCharge r2)
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
public static FloatElectricalCharge valueOf(String text)
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 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
public static FloatElectricalCharge of(float value, String unitString)
Returns a FloatElectricalCharge based on a value and the textual representation of the unit.- 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
public final FloatDimensionless divide(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
-
divide
public final FloatElectricalCurrent divide(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
-
divide
public final FloatDuration divide(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
-
divide
public final FloatElectricalCapacitance divide(FloatElectricalPotential v)
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
public final FloatElectricalPotential divide(FloatElectricalCapacitance v)
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
-
-