View Javadoc
1   package org.djunits.value.vdouble.scalar;
2   
3   import java.util.Locale;
4   
5   import org.djunits.unit.DimensionlessUnit;
6   import org.djunits.unit.DurationUnit;
7   import org.djunits.unit.ElectricalCapacitanceUnit;
8   import org.djunits.unit.ElectricalChargeUnit;
9   import org.djunits.unit.ElectricalCurrentUnit;
10  import org.djunits.unit.ElectricalPotentialUnit;
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   * Easy access methods for the ElectricalCharge DoubleScalar, which is relative by definition.
20   * <p>
21   * Copyright (c) 2013-2023 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
22   * BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
23   * </p>
24   * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
25   * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
26   */
27  @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-04-30T13:59:27.633664900Z")
28  public class ElectricalCharge extends AbstractDoubleScalarRel<ElectricalChargeUnit, ElectricalCharge>
29  {
30      /** */
31      private static final long serialVersionUID = 20150905L;
32  
33      /** Constant with value zero. */
34      public static final ElectricalCharge ZERO = new ElectricalCharge(0.0, ElectricalChargeUnit.SI);
35  
36      /** Constant with value one. */
37      public static final ElectricalCharge ONE = new ElectricalCharge(1.0, ElectricalChargeUnit.SI);
38  
39      /** Constant with value NaN. */
40      @SuppressWarnings("checkstyle:constantname")
41      public static final ElectricalCharge NaN = new ElectricalCharge(Double.NaN, ElectricalChargeUnit.SI);
42  
43      /** Constant with value POSITIVE_INFINITY. */
44      public static final ElectricalCharge POSITIVE_INFINITY =
45              new ElectricalCharge(Double.POSITIVE_INFINITY, ElectricalChargeUnit.SI);
46  
47      /** Constant with value NEGATIVE_INFINITY. */
48      public static final ElectricalCharge NEGATIVE_INFINITY =
49              new ElectricalCharge(Double.NEGATIVE_INFINITY, ElectricalChargeUnit.SI);
50  
51      /** Constant with value MAX_VALUE. */
52      public static final ElectricalCharge POS_MAXVALUE = new ElectricalCharge(Double.MAX_VALUE, ElectricalChargeUnit.SI);
53  
54      /** Constant with value -MAX_VALUE. */
55      public static final ElectricalCharge NEG_MAXVALUE = new ElectricalCharge(-Double.MAX_VALUE, ElectricalChargeUnit.SI);
56  
57      /**
58       * Construct ElectricalCharge scalar.
59       * @param value double; the double value
60       * @param unit ElectricalChargeUnit; unit for the double value
61       */
62      public ElectricalCharge(final double value, final ElectricalChargeUnit unit)
63      {
64          super(value, unit);
65      }
66  
67      /**
68       * Construct ElectricalCharge scalar.
69       * @param value ElectricalCharge; Scalar from which to construct this instance
70       */
71      public ElectricalCharge(final ElectricalCharge value)
72      {
73          super(value);
74      }
75  
76      /** {@inheritDoc} */
77      @Override
78      public final ElectricalCharge instantiateRel(final double value, final ElectricalChargeUnit unit)
79      {
80          return new ElectricalCharge(value, unit);
81      }
82  
83      /**
84       * Construct ElectricalCharge scalar.
85       * @param value double; the double value in SI units
86       * @return ElectricalCharge; the new scalar with the SI value
87       */
88      public static final ElectricalCharge instantiateSI(final double value)
89      {
90          return new ElectricalCharge(value, ElectricalChargeUnit.SI);
91      }
92  
93      /**
94       * Interpolate between two values.
95       * @param zero ElectricalCharge; the low value
96       * @param one ElectricalCharge; the high value
97       * @param ratio double; the ratio between 0 and 1, inclusive
98       * @return ElectricalCharge; a Scalar at the ratio between
99       */
100     public static ElectricalCharge interpolate(final ElectricalCharge zero, final ElectricalCharge one, final double ratio)
101     {
102         return new ElectricalCharge(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
103                 zero.getDisplayUnit());
104     }
105 
106     /**
107      * Return the maximum value of two relative scalars.
108      * @param r1 ElectricalCharge; the first scalar
109      * @param r2 ElectricalCharge; the second scalar
110      * @return ElectricalCharge; the maximum value of two relative scalars
111      */
112     public static ElectricalCharge max(final ElectricalCharge r1, final ElectricalCharge r2)
113     {
114         return r1.gt(r2) ? r1 : r2;
115     }
116 
117     /**
118      * Return the maximum value of more than two relative scalars.
119      * @param r1 ElectricalCharge; the first scalar
120      * @param r2 ElectricalCharge; the second scalar
121      * @param rn ElectricalCharge...; the other scalars
122      * @return ElectricalCharge; the maximum value of more than two relative scalars
123      */
124     public static ElectricalCharge max(final ElectricalCharge r1, final ElectricalCharge r2, final ElectricalCharge... rn)
125     {
126         ElectricalCharge maxr = r1.gt(r2) ? r1 : r2;
127         for (ElectricalCharge r : rn)
128         {
129             if (r.gt(maxr))
130             {
131                 maxr = r;
132             }
133         }
134         return maxr;
135     }
136 
137     /**
138      * Return the minimum value of two relative scalars.
139      * @param r1 ElectricalCharge; the first scalar
140      * @param r2 ElectricalCharge; the second scalar
141      * @return ElectricalCharge; the minimum value of two relative scalars
142      */
143     public static ElectricalCharge min(final ElectricalCharge r1, final ElectricalCharge r2)
144     {
145         return r1.lt(r2) ? r1 : r2;
146     }
147 
148     /**
149      * Return the minimum value of more than two relative scalars.
150      * @param r1 ElectricalCharge; the first scalar
151      * @param r2 ElectricalCharge; the second scalar
152      * @param rn ElectricalCharge...; the other scalars
153      * @return ElectricalCharge; the minimum value of more than two relative scalars
154      */
155     public static ElectricalCharge min(final ElectricalCharge r1, final ElectricalCharge r2, final ElectricalCharge... rn)
156     {
157         ElectricalCharge minr = r1.lt(r2) ? r1 : r2;
158         for (ElectricalCharge r : rn)
159         {
160             if (r.lt(minr))
161             {
162                 minr = r;
163             }
164         }
165         return minr;
166     }
167 
168     /**
169      * Returns a ElectricalCharge representation of a textual representation of a value with a unit. The String representation
170      * that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces
171      * are allowed, but not required, between the value and the unit.
172      * @param text String; the textual representation to parse into a ElectricalCharge
173      * @return ElectricalCharge; the Scalar representation of the value in its unit
174      * @throws IllegalArgumentException when the text cannot be parsed
175      * @throws NullPointerException when the text argument is null
176      */
177     public static ElectricalCharge valueOf(final String text)
178     {
179         Throw.whenNull(text, "Error parsing ElectricalCharge: text to parse is null");
180         Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing ElectricalCharge: empty text to parse");
181         try
182         {
183             NumberParser numberParser = new NumberParser().lenient().trailing();
184             double d = numberParser.parseDouble(text);
185             String unitString = text.substring(numberParser.getTrailingPosition()).trim();
186             ElectricalChargeUnit unit = ElectricalChargeUnit.BASE.getUnitByAbbreviation(unitString);
187             if (unit == null)
188                 throw new IllegalArgumentException("Unit " + unitString + " not found");
189             return new ElectricalCharge(d, unit);
190         }
191         catch (Exception exception)
192         {
193             throw new IllegalArgumentException("Error parsing ElectricalCharge from " + text + " using Locale "
194                     + Locale.getDefault(Locale.Category.FORMAT), exception);
195         }
196     }
197 
198     /**
199      * Returns a ElectricalCharge based on a value and the textual representation of the unit, which can be localized.
200      * @param value double; the value to use
201      * @param unitString String; the textual representation of the unit
202      * @return ElectricalCharge; the Scalar representation of the value in its unit
203      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
204      * @throws NullPointerException when the unitString argument is null
205      */
206     public static ElectricalCharge of(final double value, final String unitString)
207     {
208         Throw.whenNull(unitString, "Error parsing ElectricalCharge: unitString is null");
209         Throw.when(unitString.length() == 0, IllegalArgumentException.class,
210                 "Error parsing ElectricalCharge: empty unitString");
211         ElectricalChargeUnit unit = ElectricalChargeUnit.BASE.getUnitByAbbreviation(unitString);
212         if (unit != null)
213         {
214             return new ElectricalCharge(value, unit);
215         }
216         throw new IllegalArgumentException("Error parsing ElectricalCharge with unit " + unitString);
217     }
218 
219     /**
220      * Calculate the division of ElectricalCharge and ElectricalCharge, which results in a Dimensionless scalar.
221      * @param v ElectricalCharge; scalar
222      * @return Dimensionless; scalar as a division of ElectricalCharge and ElectricalCharge
223      */
224     public final Dimensionless divide(final ElectricalCharge v)
225     {
226         return new Dimensionless(this.si / v.si, DimensionlessUnit.SI);
227     }
228 
229     /**
230      * Calculate the division of ElectricalCharge and Duration, which results in a ElectricalCurrent scalar.
231      * @param v ElectricalCharge; scalar
232      * @return ElectricalCurrent; scalar as a division of ElectricalCharge and Duration
233      */
234     public final ElectricalCurrent divide(final Duration v)
235     {
236         return new ElectricalCurrent(this.si / v.si, ElectricalCurrentUnit.SI);
237     }
238 
239     /**
240      * Calculate the division of ElectricalCharge and ElectricalCurrent, which results in a Duration scalar.
241      * @param v ElectricalCharge; scalar
242      * @return Duration; scalar as a division of ElectricalCharge and ElectricalCurrent
243      */
244     public final Duration divide(final ElectricalCurrent v)
245     {
246         return new Duration(this.si / v.si, DurationUnit.SI);
247     }
248 
249     /**
250      * Calculate the division of ElectricalCharge and ElectricalPotential, which results in a ElectricalCapacitance scalar.
251      * @param v ElectricalCharge; scalar
252      * @return ElectricalCapacitance; scalar as a division of ElectricalCharge and ElectricalPotential
253      */
254     public final ElectricalCapacitance divide(final ElectricalPotential v)
255     {
256         return new ElectricalCapacitance(this.si / v.si, ElectricalCapacitanceUnit.SI);
257     }
258 
259     /**
260      * Calculate the division of ElectricalCharge and ElectricalCapacitance, which results in a ElectricalPotential scalar.
261      * @param v ElectricalCharge; scalar
262      * @return ElectricalPotential; scalar as a division of ElectricalCharge and ElectricalCapacitance
263      */
264     public final ElectricalPotential divide(final ElectricalCapacitance v)
265     {
266         return new ElectricalPotential(this.si / v.si, ElectricalPotentialUnit.SI);
267     }
268 
269     /** {@inheritDoc} */
270     @Override
271     public SIScalar reciprocal()
272     {
273         return DoubleScalar.divide(Dimensionless.ONE, this);
274     }
275 
276 }