Package org.djunits.value.vfloat.scalar
Class FloatMagneticFlux
- 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<MagneticFluxUnit,FloatMagneticFlux>
-
- org.djunits.value.vfloat.scalar.FloatMagneticFlux
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<FloatMagneticFlux>
,Scalar<MagneticFluxUnit,FloatMagneticFlux>
,Scalar.Rel<MagneticFluxUnit,FloatMagneticFlux>
,ValueFunctions<MagneticFluxUnit,FloatMagneticFlux>
,Relative<MagneticFluxUnit,FloatMagneticFlux>
,Value<MagneticFluxUnit,FloatMagneticFlux>
,FloatScalarInterface<MagneticFluxUnit,FloatMagneticFlux>
,FloatScalarInterface.Rel<MagneticFluxUnit,FloatMagneticFlux>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2023-04-30T13:59:27.633664900Z") public class FloatMagneticFlux extends AbstractFloatScalarRel<MagneticFluxUnit,FloatMagneticFlux>
Easy access methods for the FloatMagneticFlux FloatScalar, which is relative by definition.Copyright (c) 2013-2023 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 FloatMagneticFlux
NaN
Constant with value NaN.static FloatMagneticFlux
NEG_MAXVALUE
Constant with value -MAX_VALUE.static FloatMagneticFlux
NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY.static FloatMagneticFlux
ONE
Constant with value one.static FloatMagneticFlux
POS_MAXVALUE
Constant with value MAX_VALUE.static FloatMagneticFlux
POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY.static FloatMagneticFlux
ZERO
Constant with value zero.-
Fields inherited from class org.djunits.value.vfloat.scalar.base.AbstractFloatScalar
si
-
-
Constructor Summary
Constructors Constructor Description FloatMagneticFlux(double value, MagneticFluxUnit unit)
Construct FloatMagneticFlux scalar using a double value.FloatMagneticFlux(float value, MagneticFluxUnit unit)
Construct FloatMagneticFlux scalar.FloatMagneticFlux(FloatMagneticFlux value)
Construct FloatMagneticFlux scalar.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FloatMagneticFluxDensity
divide(FloatArea v)
Calculate the division of FloatMagneticFlux and FloatArea, which results in a FloatMagneticFluxDensity scalar.FloatElectricalPotential
divide(FloatDuration v)
Calculate the division of FloatMagneticFlux and FloatDuration, which results in a FloatElectricalPotential scalar.FloatElectricalInductance
divide(FloatElectricalCurrent v)
Calculate the division of FloatMagneticFlux and FloatElectricalCurrent, which results in a FloatElectricalInductance scalar.FloatElectricalCurrent
divide(FloatElectricalInductance v)
Calculate the division of FloatMagneticFlux and FloatElectricalInductance, which results in a FloatElectricalCurrent scalar.FloatDuration
divide(FloatElectricalPotential v)
Calculate the division of FloatMagneticFlux and FloatElectricalPotential, which results in a FloatDuration scalar.FloatDimensionless
divide(FloatMagneticFlux v)
Calculate the division of FloatMagneticFlux and FloatMagneticFlux, which results in a FloatDimensionless scalar.FloatArea
divide(FloatMagneticFluxDensity v)
Calculate the division of FloatMagneticFlux and FloatMagneticFluxDensity, which results in a FloatArea scalar.FloatMagneticFlux
instantiateRel(float value, MagneticFluxUnit unit)
Construct a new Relative Immutable FloatScalar of the right type.static FloatMagneticFlux
instantiateSI(float value)
Construct FloatMagneticFlux scalar.static FloatMagneticFlux
interpolate(FloatMagneticFlux zero, FloatMagneticFlux one, float ratio)
Interpolate between two values.static FloatMagneticFlux
max(FloatMagneticFlux r1, FloatMagneticFlux r2)
Return the maximum value of two relative scalars.static FloatMagneticFlux
max(FloatMagneticFlux r1, FloatMagneticFlux r2, FloatMagneticFlux... rn)
Return the maximum value of more than two relative scalars.static FloatMagneticFlux
min(FloatMagneticFlux r1, FloatMagneticFlux r2)
Return the minimum value of two relative scalars.static FloatMagneticFlux
min(FloatMagneticFlux r1, FloatMagneticFlux r2, FloatMagneticFlux... rn)
Return the minimum value of more than two relative scalars.static FloatMagneticFlux
of(float value, String unitString)
Returns a FloatMagneticFlux 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.static FloatMagneticFlux
valueOf(String text)
Returns a FloatMagneticFlux 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, format, format, 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 FloatMagneticFlux ZERO
Constant with value zero.
-
ONE
public static final FloatMagneticFlux ONE
Constant with value one.
-
NaN
public static final FloatMagneticFlux NaN
Constant with value NaN.
-
POSITIVE_INFINITY
public static final FloatMagneticFlux POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY.
-
NEGATIVE_INFINITY
public static final FloatMagneticFlux NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY.
-
POS_MAXVALUE
public static final FloatMagneticFlux POS_MAXVALUE
Constant with value MAX_VALUE.
-
NEG_MAXVALUE
public static final FloatMagneticFlux NEG_MAXVALUE
Constant with value -MAX_VALUE.
-
-
Constructor Detail
-
FloatMagneticFlux
public FloatMagneticFlux(float value, MagneticFluxUnit unit)
Construct FloatMagneticFlux scalar.- Parameters:
value
- float; the float valueunit
- unit for the float value
-
FloatMagneticFlux
public FloatMagneticFlux(FloatMagneticFlux value)
Construct FloatMagneticFlux scalar.- Parameters:
value
- Scalar from which to construct this instance
-
FloatMagneticFlux
public FloatMagneticFlux(double value, MagneticFluxUnit unit)
Construct FloatMagneticFlux scalar using a double value.- Parameters:
value
- double; the double valueunit
- unit for the resulting float value
-
-
Method Detail
-
instantiateRel
public final FloatMagneticFlux instantiateRel(float value, MagneticFluxUnit 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 FloatMagneticFlux instantiateSI(float value)
Construct FloatMagneticFlux scalar.- Parameters:
value
- float; the float value in SI units- Returns:
- the new scalar with the SI value
-
interpolate
public static FloatMagneticFlux interpolate(FloatMagneticFlux zero, FloatMagneticFlux 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 FloatMagneticFlux max(FloatMagneticFlux r1, FloatMagneticFlux 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 FloatMagneticFlux max(FloatMagneticFlux r1, FloatMagneticFlux r2, FloatMagneticFlux... 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 FloatMagneticFlux min(FloatMagneticFlux r1, FloatMagneticFlux 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 FloatMagneticFlux min(FloatMagneticFlux r1, FloatMagneticFlux r2, FloatMagneticFlux... 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 FloatMagneticFlux valueOf(String text)
Returns a FloatMagneticFlux 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 FloatMagneticFlux- Returns:
- FloatMagneticFlux; 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 FloatMagneticFlux of(float value, String unitString)
Returns a FloatMagneticFlux 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:
- FloatMagneticFlux; 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(FloatMagneticFlux v)
Calculate the division of FloatMagneticFlux and FloatMagneticFlux, which results in a FloatDimensionless scalar.- Parameters:
v
- FloatMagneticFlux; scalar- Returns:
- FloatDimensionless; scalar as a division of FloatMagneticFlux and FloatMagneticFlux
-
divide
public final FloatDuration divide(FloatElectricalPotential v)
Calculate the division of FloatMagneticFlux and FloatElectricalPotential, which results in a FloatDuration scalar.- Parameters:
v
- FloatMagneticFlux; scalar- Returns:
- FloatDuration; scalar as a division of FloatMagneticFlux and FloatElectricalPotential
-
divide
public final FloatElectricalPotential divide(FloatDuration v)
Calculate the division of FloatMagneticFlux and FloatDuration, which results in a FloatElectricalPotential scalar.- Parameters:
v
- FloatMagneticFlux; scalar- Returns:
- FloatElectricalPotential; scalar as a division of FloatMagneticFlux and FloatDuration
-
divide
public final FloatMagneticFluxDensity divide(FloatArea v)
Calculate the division of FloatMagneticFlux and FloatArea, which results in a FloatMagneticFluxDensity scalar.- Parameters:
v
- FloatMagneticFlux; scalar- Returns:
- FloatMagneticFluxDensity; scalar as a division of FloatMagneticFlux and FloatArea
-
divide
public final FloatArea divide(FloatMagneticFluxDensity v)
Calculate the division of FloatMagneticFlux and FloatMagneticFluxDensity, which results in a FloatArea scalar.- Parameters:
v
- FloatMagneticFlux; scalar- Returns:
- FloatArea; scalar as a division of FloatMagneticFlux and FloatMagneticFluxDensity
-
divide
public final FloatElectricalInductance divide(FloatElectricalCurrent v)
Calculate the division of FloatMagneticFlux and FloatElectricalCurrent, which results in a FloatElectricalInductance scalar.- Parameters:
v
- FloatMagneticFlux; scalar- Returns:
- FloatElectricalInductance; scalar as a division of FloatMagneticFlux and FloatElectricalCurrent
-
divide
public final FloatElectricalCurrent divide(FloatElectricalInductance v)
Calculate the division of FloatMagneticFlux and FloatElectricalInductance, which results in a FloatElectricalCurrent scalar.- Parameters:
v
- FloatMagneticFlux; scalar- Returns:
- FloatElectricalCurrent; scalar as a division of FloatMagneticFlux and FloatElectricalInductance
-
reciprocal
public FloatSIScalar reciprocal()
Create the reciprocal of this scalar with the correct dimensions.- Specified by:
reciprocal
in classAbstractFloatScalarRel<MagneticFluxUnit,FloatMagneticFlux>
- Returns:
- FloatScalar<?>; a new scalar instance with correct SI dimensions
-
-