1 package org.djunits.value.vdouble.scalar;
2
3 import java.util.Locale;
4
5 import org.djunits.unit.AreaUnit;
6 import org.djunits.unit.DimensionlessUnit;
7 import org.djunits.unit.IlluminanceUnit;
8 import org.djunits.unit.LuminousFluxUnit;
9 import org.djunits.unit.LuminousIntensityUnit;
10 import org.djunits.unit.SolidAngleUnit;
11 import org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel;
12 import org.djunits.value.vdouble.scalar.base.DoubleScalar;
13 import org.djutils.base.NumberParser;
14 import org.djutils.exceptions.Throw;
15
16 import jakarta.annotation.Generated;
17
18
19
20
21
22
23
24
25
26
27 @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-04-30T13:59:27.633664900Z")
28 public class LuminousFlux extends AbstractDoubleScalarRel<LuminousFluxUnit, LuminousFlux>
29 {
30
31 private static final long serialVersionUID = 20150905L;
32
33
34 public static final LuminousFlux ZERO = new LuminousFlux(0.0, LuminousFluxUnit.SI);
35
36
37 public static final LuminousFlux ONE = new LuminousFlux(1.0, LuminousFluxUnit.SI);
38
39
40 @SuppressWarnings("checkstyle:constantname")
41 public static final LuminousFlux NaN = new LuminousFlux(Double.NaN, LuminousFluxUnit.SI);
42
43
44 public static final LuminousFlux POSITIVE_INFINITY = new LuminousFlux(Double.POSITIVE_INFINITY, LuminousFluxUnit.SI);
45
46
47 public static final LuminousFlux NEGATIVE_INFINITY = new LuminousFlux(Double.NEGATIVE_INFINITY, LuminousFluxUnit.SI);
48
49
50 public static final LuminousFlux POS_MAXVALUE = new LuminousFlux(Double.MAX_VALUE, LuminousFluxUnit.SI);
51
52
53 public static final LuminousFlux NEG_MAXVALUE = new LuminousFlux(-Double.MAX_VALUE, LuminousFluxUnit.SI);
54
55
56
57
58
59
60 public LuminousFlux(final double value, final LuminousFluxUnit unit)
61 {
62 super(value, unit);
63 }
64
65
66
67
68
69 public LuminousFlux(final LuminousFlux value)
70 {
71 super(value);
72 }
73
74
75 @Override
76 public final LuminousFlux instantiateRel(final double value, final LuminousFluxUnit unit)
77 {
78 return new LuminousFlux(value, unit);
79 }
80
81
82
83
84
85
86 public static final LuminousFlux instantiateSI(final double value)
87 {
88 return new LuminousFlux(value, LuminousFluxUnit.SI);
89 }
90
91
92
93
94
95
96
97
98 public static LuminousFlux interpolate(final LuminousFlux zero, final LuminousFlux one, final double ratio)
99 {
100 return new LuminousFlux(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
101 zero.getDisplayUnit());
102 }
103
104
105
106
107
108
109
110 public static LuminousFlux max(final LuminousFlux r1, final LuminousFlux r2)
111 {
112 return r1.gt(r2) ? r1 : r2;
113 }
114
115
116
117
118
119
120
121
122 public static LuminousFlux max(final LuminousFlux r1, final LuminousFlux r2, final LuminousFlux... rn)
123 {
124 LuminousFlux maxr = r1.gt(r2) ? r1 : r2;
125 for (LuminousFlux r : rn)
126 {
127 if (r.gt(maxr))
128 {
129 maxr = r;
130 }
131 }
132 return maxr;
133 }
134
135
136
137
138
139
140
141 public static LuminousFlux min(final LuminousFlux r1, final LuminousFlux r2)
142 {
143 return r1.lt(r2) ? r1 : r2;
144 }
145
146
147
148
149
150
151
152
153 public static LuminousFlux min(final LuminousFlux r1, final LuminousFlux r2, final LuminousFlux... rn)
154 {
155 LuminousFlux minr = r1.lt(r2) ? r1 : r2;
156 for (LuminousFlux r : rn)
157 {
158 if (r.lt(minr))
159 {
160 minr = r;
161 }
162 }
163 return minr;
164 }
165
166
167
168
169
170
171
172
173
174
175 public static LuminousFlux valueOf(final String text)
176 {
177 Throw.whenNull(text, "Error parsing LuminousFlux: text to parse is null");
178 Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing LuminousFlux: empty text to parse");
179 try
180 {
181 NumberParser numberParser = new NumberParser().lenient().trailing();
182 double d = numberParser.parseDouble(text);
183 String unitString = text.substring(numberParser.getTrailingPosition()).trim();
184 LuminousFluxUnit unit = LuminousFluxUnit.BASE.getUnitByAbbreviation(unitString);
185 if (unit == null)
186 throw new IllegalArgumentException("Unit " + unitString + " not found");
187 return new LuminousFlux(d, unit);
188 }
189 catch (Exception exception)
190 {
191 throw new IllegalArgumentException(
192 "Error parsing LuminousFlux from " + text + " using Locale " + Locale.getDefault(Locale.Category.FORMAT),
193 exception);
194 }
195 }
196
197
198
199
200
201
202
203
204
205 public static LuminousFlux of(final double value, final String unitString)
206 {
207 Throw.whenNull(unitString, "Error parsing LuminousFlux: unitString is null");
208 Throw.when(unitString.length() == 0, IllegalArgumentException.class, "Error parsing LuminousFlux: empty unitString");
209 LuminousFluxUnit unit = LuminousFluxUnit.BASE.getUnitByAbbreviation(unitString);
210 if (unit != null)
211 {
212 return new LuminousFlux(value, unit);
213 }
214 throw new IllegalArgumentException("Error parsing LuminousFlux with unit " + unitString);
215 }
216
217
218
219
220
221
222 public final Dimensionless divide(final LuminousFlux v)
223 {
224 return new Dimensionless(this.si / v.si, DimensionlessUnit.SI);
225 }
226
227
228
229
230
231
232 public final Illuminance divide(final Area v)
233 {
234 return new Illuminance(this.si / v.si, IlluminanceUnit.SI);
235 }
236
237
238
239
240
241
242 public final Area divide(final Illuminance v)
243 {
244 return new Area(this.si / v.si, AreaUnit.SI);
245 }
246
247
248
249
250
251
252 public final SolidAngle divide(final LuminousIntensity v)
253 {
254 return new SolidAngle(this.si / v.si, SolidAngleUnit.SI);
255 }
256
257
258
259
260
261
262 public final LuminousIntensity divide(final SolidAngle v)
263 {
264 return new LuminousIntensity(this.si / v.si, LuminousIntensityUnit.SI);
265 }
266
267
268 @Override
269 public SIScalar reciprocal()
270 {
271 return DoubleScalar.divide(Dimensionless.ONE, this);
272 }
273
274 }