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