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