Package org.djunits.value.vdouble.scalar
Class Illuminance
java.lang.Object
java.lang.Number
org.djunits.value.base.Scalar<U,S>
org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>
org.djunits.value.vdouble.scalar.base.DoubleScalarRel<IlluminanceUnit,Illuminance>
org.djunits.value.vdouble.scalar.Illuminance
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<Illuminance>
,Relative<IlluminanceUnit,
,Illuminance> Value<IlluminanceUnit,
Illuminance>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class Illuminance
extends DoubleScalarRel<IlluminanceUnit,Illuminance>
Easy access methods for the Illuminance DoubleScalar, 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 Illuminance
Constant with value NaN.static final Illuminance
Constant with value -MAX_VALUE.static final Illuminance
Constant with value NEGATIVE_INFINITY.static final Illuminance
Constant with value one.static final Illuminance
Constant with value MAX_VALUE.static final Illuminance
Constant with value POSITIVE_INFINITY.static final Illuminance
Constant with value zero.Fields inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar
si
-
Constructor Summary
ConstructorDescriptionIlluminance
(double value, IlluminanceUnit unit) Construct Illuminance scalar.Illuminance
(Illuminance value) Construct Illuminance scalar. -
Method Summary
Modifier and TypeMethodDescriptionfinal Dimensionless
Calculate the division of Illuminance and Illuminance, which results in a Dimensionless scalar.final Illuminance
instantiateRel
(double value, IlluminanceUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.static final Illuminance
instantiateSI
(double value) Construct Illuminance scalar.static Illuminance
interpolate
(Illuminance zero, Illuminance one, double ratio) Interpolate between two values.static Illuminance
max
(Illuminance r1, Illuminance r2) Return the maximum value of two relative scalars.static Illuminance
max
(Illuminance r1, Illuminance r2, Illuminance... rn) Return the maximum value of more than two relative scalars.static Illuminance
min
(Illuminance r1, Illuminance r2) Return the minimum value of two relative scalars.static Illuminance
min
(Illuminance r1, Illuminance r2, Illuminance... rn) Return the minimum value of more than two relative scalars.static Illuminance
Returns a Illuminance 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.final LuminousFlux
Calculate the multiplication of Illuminance and Area, which results in a LuminousFlux scalar.static Illuminance
Returns a Illuminance representation of a textual representation of a value with a unit.Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalarRel
abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times
Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar
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
-
Illuminance
Construct Illuminance scalar.- Parameters:
value
- double; the double valueunit
- IlluminanceUnit; unit for the double value
-
Illuminance
Construct Illuminance scalar.- Parameters:
value
- Illuminance; Scalar from which to construct this instance
-
-
Method Details
-
instantiateRel
Description copied from class:DoubleScalarRel
Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.- Specified by:
instantiateRel
in classDoubleScalarRel<IlluminanceUnit,
Illuminance> - Parameters:
value
- double; the double valueunit
- U; the unit- Returns:
- R a new relative instance of the DoubleScalar of the right type
-
instantiateSI
Construct Illuminance scalar.- Parameters:
value
- double; the double value in SI units- Returns:
- Illuminance; the new scalar with the SI value
-
interpolate
Interpolate between two values.- Parameters:
zero
- Illuminance; the low valueone
- Illuminance; the high valueratio
- double; the ratio between 0 and 1, inclusive- Returns:
- Illuminance; a Scalar at the ratio between
-
max
Return the maximum value of two relative scalars.- Parameters:
r1
- Illuminance; the first scalarr2
- Illuminance; the second scalar- Returns:
- Illuminance; the maximum value of two relative scalars
-
max
Return the maximum value of more than two relative scalars.- Parameters:
r1
- Illuminance; the first scalarr2
- Illuminance; the second scalarrn
- Illuminance...; the other scalars- Returns:
- Illuminance; the maximum value of more than two relative scalars
-
min
Return the minimum value of two relative scalars.- Parameters:
r1
- Illuminance; the first scalarr2
- Illuminance; the second scalar- Returns:
- Illuminance; the minimum value of two relative scalars
-
min
Return the minimum value of more than two relative scalars.- Parameters:
r1
- Illuminance; the first scalarr2
- Illuminance; the second scalarrn
- Illuminance...; the other scalars- Returns:
- Illuminance; the minimum value of more than two relative scalars
-
valueOf
Returns a Illuminance 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 Illuminance- Returns:
- Illuminance; 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 Illuminance 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:
- Illuminance; 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 Illuminance and Illuminance, which results in a Dimensionless scalar.- Parameters:
v
- Illuminance; scalar- Returns:
- Dimensionless; scalar as a division of Illuminance and Illuminance
-
times
Calculate the multiplication of Illuminance and Area, which results in a LuminousFlux scalar.- Parameters:
v
- Illuminance; scalar- Returns:
- LuminousFlux; scalar as a multiplication of Illuminance and Area
-
reciprocal
Description copied from class:DoubleScalarRel
Create the reciprocal of this scalar with the correct dimensions.- Specified by:
reciprocal
in classDoubleScalarRel<IlluminanceUnit,
Illuminance> - Returns:
- DoubleScalar<?>; a new scalar instance with correct SI dimensions
-