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