1 package org.djunits.quantity;
2
3 import org.djunits.quantity.def.Quantity;
4 import org.djunits.unit.AbstractUnit;
5 import org.djunits.unit.UnitRuntimeException;
6 import org.djunits.unit.Unitless;
7 import org.djunits.unit.scale.LinearScale;
8 import org.djunits.unit.scale.Scale;
9 import org.djunits.unit.si.SIUnit;
10 import org.djunits.unit.system.UnitSystem;
11
12 /**
13 * Luminous intensity is the luminous flux emitted per unit solid angle, measured in candelas (cd).
14 * <p>
15 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
16 * for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
17 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
18 * @author Alexander Verbraeck
19 */
20 public class LuminousIntensity extends Quantity<LuminousIntensity>
21 {
22 /** Constant with value zero. */
23 public static final LuminousIntensity ZERO = ofSi(0.0);
24
25 /** Constant with value one. */
26 public static final LuminousIntensity ONE = ofSi(1.0);
27
28 /** Constant with value NaN. */
29 @SuppressWarnings("checkstyle:constantname")
30 public static final LuminousIntensity NaN = ofSi(Double.NaN);
31
32 /** Constant with value POSITIVE_INFINITY. */
33 public static final LuminousIntensity POSITIVE_INFINITY = ofSi(Double.POSITIVE_INFINITY);
34
35 /** Constant with value NEGATIVE_INFINITY. */
36 public static final LuminousIntensity NEGATIVE_INFINITY = ofSi(Double.NEGATIVE_INFINITY);
37
38 /** Constant with value MAX_VALUE. */
39 public static final LuminousIntensity POS_MAXVALUE = ofSi(Double.MAX_VALUE);
40
41 /** Constant with value -MAX_VALUE. */
42 public static final LuminousIntensity NEG_MAXVALUE = ofSi(-Double.MAX_VALUE);
43
44 /** */
45 private static final long serialVersionUID = 600L;
46
47 /**
48 * Instantiate a LuminousIntensity quantity with a unit.
49 * @param valueInUnit the value, expressed in the unit
50 * @param unit the unit in which the value is expressed
51 */
52 public LuminousIntensity(final double valueInUnit, final LuminousIntensity.Unit unit)
53 {
54 super(valueInUnit, unit);
55 }
56
57 /**
58 * Return a LuminousIntensity instance based on an SI value.
59 * @param si the si value
60 * @return the LuminousIntensity instance based on an SI value
61 */
62 public static LuminousIntensity ofSi(final double si)
63 {
64 return new LuminousIntensity(si, LuminousIntensity.Unit.SI);
65 }
66
67 @Override
68 public LuminousIntensity instantiateSi(final double si)
69 {
70 return ofSi(si);
71 }
72
73 @Override
74 public SIUnit siUnit()
75 {
76 return LuminousIntensity.Unit.SI_UNIT;
77 }
78
79 /**
80 * Returns a LuminousIntensity representation of a textual representation of a value with a unit. The String representation
81 * that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces
82 * are allowed, but not required, between the value and the unit.
83 * @param text the textual representation to parse into a LuminousIntensity
84 * @return the Scalar representation of the value in its unit
85 * @throws IllegalArgumentException when the text cannot be parsed
86 * @throws NullPointerException when the text argument is null
87 */
88 public static LuminousIntensity valueOf(final String text)
89 {
90 return Quantity.valueOf(text, ZERO);
91 }
92
93 /**
94 * Returns a LuminousIntensity based on a value and the textual representation of the unit, which can be localized.
95 * @param valueInUnit the value, expressed in the unit as given by unitString
96 * @param unitString the textual representation of the unit
97 * @return the Scalar representation of the value in its unit
98 * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
99 * @throws NullPointerException when the unitString argument is null
100 */
101 public static LuminousIntensity of(final double valueInUnit, final String unitString)
102 {
103 return Quantity.of(valueInUnit, unitString, ZERO);
104 }
105
106 @Override
107 public LuminousIntensity.Unit getDisplayUnit()
108 {
109 return (LuminousIntensity.Unit) super.getDisplayUnit();
110 }
111
112 /**
113 * Calculate the division of LuminousIntensity and LuminousIntensity, which results in a Dimensionless quantity.
114 * @param v quantity
115 * @return quantity as a division of LuminousIntensity and LuminousIntensity
116 */
117 public final Dimensionless divide(final LuminousIntensity v)
118 {
119 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
120 }
121
122 /**
123 * Calculate the multiplication of LuminousIntensity and SolidAngle, which results in a LuminousFlux scalar.
124 * @param v scalar
125 * @return scalar as a multiplication of LuminousIntensity and SolidAngle
126 */
127 public final LuminousFlux multiply(final SolidAngle v)
128 {
129 return new LuminousFlux(this.si() * v.si(), LuminousFlux.Unit.SI);
130 }
131
132 /******************************************************************************************************/
133 /********************************************** UNIT CLASS ********************************************/
134 /******************************************************************************************************/
135
136 /**
137 * LuminousIntensity.Unit encodes the units of luminous flux emitted per unit solid angle.
138 * <p>
139 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
140 * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
141 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
142 * @author Alexander Verbraeck
143 */
144 @SuppressWarnings("checkstyle:constantname")
145 public static class Unit extends AbstractUnit<LuminousIntensity.Unit, LuminousIntensity>
146 {
147 /** The dimensions of the luminous flux emitted per unit solid angle: cd. */
148 public static final SIUnit SI_UNIT = SIUnit.of("cd");
149
150 /** Candela. */
151 public static final LuminousIntensity.Unit cd = new LuminousIntensity.Unit("cd", "candela", 1.0, UnitSystem.SI_DERIVED);
152
153 /** The SI or BASE unit. */
154 public static final LuminousIntensity.Unit SI = cd.generateSiPrefixes(false, false);
155
156 /**
157 * Create a new LuminousIntensity unit.
158 * @param id the id or main abbreviation of the unit
159 * @param name the full name of the unit
160 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
161 * @param unitSystem the unit system such as SI or IMPERIAL
162 */
163 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
164 {
165 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
166 }
167
168 /**
169 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
170 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
171 * @param displayAbbreviation the display abbreviation of the unit
172 * @param name the full name of the unit
173 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
174 * @param unitSystem unit system, e.g. SI or Imperial
175 */
176 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
177 final UnitSystem unitSystem)
178 {
179 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
180 }
181
182 @Override
183 public SIUnit siUnit()
184 {
185 return SI_UNIT;
186 }
187
188 @Override
189 public Unit getBaseUnit()
190 {
191 return SI;
192 }
193
194 @Override
195 public LuminousIntensity ofSi(final double si)
196 {
197 return LuminousIntensity.ofSi(si);
198 }
199
200 @Override
201 public Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
202 final double scaleFactor, final UnitSystem unitSystem)
203 {
204 if (getScale() instanceof LinearScale ls)
205 {
206 return new LuminousIntensity.Unit(textualAbbreviation, displayAbbreviation, name,
207 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem);
208 }
209 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
210 }
211
212 }
213 }