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