Package org.djunits.value.vdouble.scalar

Class LuminousFlux

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<LuminousFluxUnit,LuminousFlux>

org.djunits.value.vdouble.scalar.LuminousFlux

All Implemented Interfaces:

Serializable, Cloneable, Comparable<LuminousFlux>, Relative<LuminousFluxUnit,LuminousFlux>, Value<LuminousFluxUnit,LuminousFlux>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class LuminousFlux
extends DoubleScalarRel<LuminousFluxUnit,LuminousFlux>

Easy access methods for the LuminousFlux 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:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final LuminousFlux	NaN	Constant with value NaN.
static final LuminousFlux	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final LuminousFlux	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final LuminousFlux	ONE	Constant with value one.
static final LuminousFlux	POS_MAXVALUE	Constant with value MAX_VALUE.
static final LuminousFlux	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final LuminousFlux	ZERO	Constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

si

Constructor Summary

Constructors

Constructor	Description
LuminousFlux(double value, LuminousFluxUnit unit)	Construct LuminousFlux scalar.
LuminousFlux(LuminousFlux value)	Construct LuminousFlux scalar.

Method Summary

Modifier and Type	Method	Description
final Illuminance	divide(Area v)	Calculate the division of LuminousFlux and Area, which results in a Illuminance scalar.
final Area	divide(Illuminance v)	Calculate the division of LuminousFlux and Illuminance, which results in a Area scalar.
final Dimensionless	divide(LuminousFlux v)	Calculate the division of LuminousFlux and LuminousFlux, which results in a Dimensionless scalar.
final SolidAngle	divide(LuminousIntensity v)	Calculate the division of LuminousFlux and LuminousIntensity, which results in a SolidAngle scalar.
final LuminousIntensity	divide(SolidAngle v)	Calculate the division of LuminousFlux and SolidAngle, which results in a LuminousIntensity scalar.
final LuminousFlux	instantiateRel(double value, LuminousFluxUnit unit)	Construct a new Relative Immutable DoubleScalar of the right type.
static final LuminousFlux	instantiateSI(double value)	Construct LuminousFlux scalar.
static LuminousFlux	interpolate(LuminousFlux zero, LuminousFlux one, double ratio)	Interpolate between two values.
static LuminousFlux	max(LuminousFlux r1, LuminousFlux r2)	Return the maximum value of two relative scalars.
static LuminousFlux	max(LuminousFlux r1, LuminousFlux r2, LuminousFlux... rn)	Return the maximum value of more than two relative scalars.
static LuminousFlux	min(LuminousFlux r1, LuminousFlux r2)	Return the minimum value of two relative scalars.
static LuminousFlux	min(LuminousFlux r1, LuminousFlux r2, LuminousFlux... rn)	Return the minimum value of more than two relative scalars.
static LuminousFlux	of(double value, String unitString)	Returns a LuminousFlux based on a value and the textual representation of the unit, which can be localized.
SIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
static LuminousFlux	valueOf(String text)	Returns a LuminousFlux 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

public static final LuminousFlux ZERO

Constant with value zero.

ONE

public static final LuminousFlux ONE

Constant with value one.

NaN

public static final LuminousFlux NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final LuminousFlux POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final LuminousFlux NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final LuminousFlux POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final LuminousFlux NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

LuminousFlux

public LuminousFlux(double value,
 LuminousFluxUnit unit)

Construct LuminousFlux scalar.

Parameters:

value - double; the double value

unit - LuminousFluxUnit; unit for the double value

LuminousFlux

public LuminousFlux(LuminousFlux value)

Construct LuminousFlux scalar.

Parameters:

value - LuminousFlux; Scalar from which to construct this instance

Method Details

instantiateRel

public final LuminousFlux instantiateRel(double value,
 LuminousFluxUnit unit)

Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateRel in class DoubleScalarRel<LuminousFluxUnit,LuminousFlux>

Parameters:

value - double; the double value

unit - U; the unit

Returns:

R a new relative instance of the DoubleScalar of the right type

instantiateSI

public static final LuminousFlux instantiateSI(double value)

Construct LuminousFlux scalar.

Parameters:

value - double; the double value in SI units

Returns:

LuminousFlux; the new scalar with the SI value

interpolate

public static LuminousFlux interpolate(LuminousFlux zero,
 LuminousFlux one,
 double ratio)

Interpolate between two values.

Parameters:

zero - LuminousFlux; the low value

one - LuminousFlux; the high value

ratio - double; the ratio between 0 and 1, inclusive

Returns:

LuminousFlux; a Scalar at the ratio between

max

public static LuminousFlux max(LuminousFlux r1,
 LuminousFlux r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - LuminousFlux; the first scalar

r2 - LuminousFlux; the second scalar

Returns:

LuminousFlux; the maximum value of two relative scalars

max

public static LuminousFlux max(LuminousFlux r1,
 LuminousFlux r2,
 LuminousFlux... rn)

Return the maximum value of more than two relative scalars.

Parameters:

r1 - LuminousFlux; the first scalar

r2 - LuminousFlux; the second scalar

rn - LuminousFlux...; the other scalars

Returns:

LuminousFlux; the maximum value of more than two relative scalars

min

public static LuminousFlux min(LuminousFlux r1,
 LuminousFlux r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - LuminousFlux; the first scalar

r2 - LuminousFlux; the second scalar

Returns:

LuminousFlux; the minimum value of two relative scalars

min

public static LuminousFlux min(LuminousFlux r1,
 LuminousFlux r2,
 LuminousFlux... rn)

Return the minimum value of more than two relative scalars.

Parameters:

r1 - LuminousFlux; the first scalar

r2 - LuminousFlux; the second scalar

rn - LuminousFlux...; the other scalars

Returns:

LuminousFlux; the minimum value of more than two relative scalars

valueOf

public static LuminousFlux valueOf(String text)

Returns a LuminousFlux 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 LuminousFlux

Returns:

LuminousFlux; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the text cannot be parsed

NullPointerException - when the text argument is null

of

public static LuminousFlux of(double value,
 String unitString)

Returns a LuminousFlux based on a value and the textual representation of the unit, which can be localized.

Parameters:

value - double; the value to use

unitString - String; the textual representation of the unit

Returns:

LuminousFlux; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the unit cannot be parsed or is incorrect

NullPointerException - when the unitString argument is null

divide

public final Dimensionless divide(LuminousFlux v)

Calculate the division of LuminousFlux and LuminousFlux, which results in a Dimensionless scalar.

Parameters:

v - LuminousFlux; scalar

Returns:

Dimensionless; scalar as a division of LuminousFlux and LuminousFlux

divide

public final Illuminance divide(Area v)

Calculate the division of LuminousFlux and Area, which results in a Illuminance scalar.

Parameters:

v - LuminousFlux; scalar

Returns:

Illuminance; scalar as a division of LuminousFlux and Area

divide

public final Area divide(Illuminance v)

Calculate the division of LuminousFlux and Illuminance, which results in a Area scalar.

Parameters:

v - LuminousFlux; scalar

Returns:

Area; scalar as a division of LuminousFlux and Illuminance

divide

public final SolidAngle divide(LuminousIntensity v)

Calculate the division of LuminousFlux and LuminousIntensity, which results in a SolidAngle scalar.

Parameters:

v - LuminousFlux; scalar

Returns:

SolidAngle; scalar as a division of LuminousFlux and LuminousIntensity

divide

public final LuminousIntensity divide(SolidAngle v)

Calculate the division of LuminousFlux and SolidAngle, which results in a LuminousIntensity scalar.

Parameters:

v - LuminousFlux; scalar

Returns:

LuminousIntensity; scalar as a division of LuminousFlux and SolidAngle

reciprocal

public SIScalar reciprocal()

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class DoubleScalarRel<LuminousFluxUnit,LuminousFlux>

Returns:

DoubleScalar<?>; a new scalar instance with correct SI dimensions