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