Package org.djunits.value.vfloat.scalar
Class FloatElectricalCurrent
- 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<ElectricalCurrentUnit,FloatElectricalCurrent>
-
- org.djunits.value.vfloat.scalar.FloatElectricalCurrent
-
- All Implemented Interfaces:
Serializable,Cloneable,Comparable<FloatElectricalCurrent>,Scalar<ElectricalCurrentUnit,FloatElectricalCurrent>,Scalar.Rel<ElectricalCurrentUnit,FloatElectricalCurrent>,ValueFunctions<ElectricalCurrentUnit,FloatElectricalCurrent>,Relative<ElectricalCurrentUnit,FloatElectricalCurrent>,Value<ElectricalCurrentUnit,FloatElectricalCurrent>,FloatScalarInterface<ElectricalCurrentUnit,FloatElectricalCurrent>,FloatScalarInterface.Rel<ElectricalCurrentUnit,FloatElectricalCurrent>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2022-03-14T11:14:15.180987200Z") public class FloatElectricalCurrent extends AbstractFloatScalarRel<ElectricalCurrentUnit,FloatElectricalCurrent>Easy access methods for the FloatElectricalCurrent FloatScalar, which is relative by definition.Copyright (c) 2013-2022 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 FloatElectricalCurrentNaNConstant with value NaN.static FloatElectricalCurrentNEG_MAXVALUEConstant with value -MAX_VALUE.static FloatElectricalCurrentNEGATIVE_INFINITYConstant with value NEGATIVE_INFINITY.static FloatElectricalCurrentONEConstant with value one.static FloatElectricalCurrentPOS_MAXVALUEConstant with value MAX_VALUE.static FloatElectricalCurrentPOSITIVE_INFINITYConstant with value POSITIVE_INFINITY.static FloatElectricalCurrentZEROConstant with value zero.-
Fields inherited from class org.djunits.value.vfloat.scalar.base.AbstractFloatScalar
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FloatElectricalPotentialdivide(FloatElectricalConductance v)Calculate the division of FloatElectricalCurrent and FloatElectricalConductance, which results in a FloatElectricalPotential scalar.FloatDimensionlessdivide(FloatElectricalCurrent v)Calculate the division of FloatElectricalCurrent and FloatElectricalCurrent, which results in a FloatDimensionless scalar.FloatElectricalConductancedivide(FloatElectricalPotential v)Calculate the division of FloatElectricalCurrent and FloatElectricalPotential, which results in a FloatElectricalConductance scalar.FloatElectricalCurrentinstantiateRel(float value, ElectricalCurrentUnit unit)Construct a new Relative Immutable FloatScalar of the right type.static FloatElectricalCurrentinstantiateSI(float value)Construct FloatElectricalCurrent scalar.static FloatElectricalCurrentinterpolate(FloatElectricalCurrent zero, FloatElectricalCurrent one, float ratio)Interpolate between two values.static FloatElectricalCurrentmax(FloatElectricalCurrent r1, FloatElectricalCurrent r2)Return the maximum value of two relative scalars.static FloatElectricalCurrentmax(FloatElectricalCurrent r1, FloatElectricalCurrent r2, FloatElectricalCurrent... rn)Return the maximum value of more than two relative scalars.static FloatElectricalCurrentmin(FloatElectricalCurrent r1, FloatElectricalCurrent r2)Return the minimum value of two relative scalars.static FloatElectricalCurrentmin(FloatElectricalCurrent r1, FloatElectricalCurrent r2, FloatElectricalCurrent... rn)Return the minimum value of more than two relative scalars.static FloatElectricalCurrentof(float value, String unitString)Returns a FloatElectricalCurrent based on a value and the textual representation of the unit.FloatSIScalarreciprocal()Create the reciprocal of this scalar with the correct dimensions.FloatElectricalChargetimes(FloatDuration v)Calculate the multiplication of FloatElectricalCurrent and FloatDuration, which results in a FloatElectricalCharge scalar.FloatPowertimes(FloatElectricalPotential v)Calculate the multiplication of FloatElectricalCurrent and FloatElectricalPotential, which results in a FloatPower scalar.FloatElectricalPotentialtimes(FloatElectricalResistance v)Calculate the multiplication of FloatElectricalCurrent and FloatElectricalResistance, which results in a FloatElectricalPotential scalar.static FloatElectricalCurrentvalueOf(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.AbstractFloatScalarRel
abs, ceil, divide, divide, divide, floor, minus, neg, plus, 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, toStringSIPrefixed, toStringSIPrefixed, 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 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 Detail
-
FloatElectricalCurrent
public FloatElectricalCurrent(float value, ElectricalCurrentUnit unit)Construct FloatElectricalCurrent scalar.- Parameters:
value- float; the float valueunit- 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 valueunit- 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.- 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 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 valueone- the high valueratio- 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 scalarr2- 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 scalarr2- the second scalarrn- 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 scalarr2- 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 scalarr2- the second scalarrn- 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 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 FloatElectricalCurrent- Returns:
- FloatElectricalCurrent; 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 FloatElectricalCurrent of(float value, String unitString)
Returns a FloatElectricalCurrent 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:
- FloatElectricalCurrent; 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(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()
Create the reciprocal of this scalar with the correct dimensions.- Specified by:
reciprocalin classAbstractFloatScalarRel<ElectricalCurrentUnit,FloatElectricalCurrent>- Returns:
- FloatScalar<?>; a new scalar instance with correct SI dimensions
-
-