Merge branch 'v4' into release/v4

Author: angularsen

Common/GeneratedCode/Quantities/Acceleration.Common.g.cs

@@ -9,7 +9,6 @@
 //     See https://github.com/angularsen/UnitsNet/wiki/Adding-a-New-Unit for how to add or edit units.
 //
 //     Add CustomCode\Quantities\MyQuantity.extra.cs files to add code to generated quantities.
-//     Add Extensions\MyQuantityExtensions.cs to decorate quantities with new behavior.
 //     Add UnitDefinitions\MyQuantity.json and run GeneratUnits.bat to generate new units or quantities.
 //
 // </auto-generated>
@@ -37,11 +36,9 @@
 // THE SOFTWARE.
 
 using System;
-using System.Collections.Generic;
-using System.Globalization;
-using System.Text.RegularExpressions;
 using System.Linq;
 using JetBrains.Annotations;
+using UnitsNet.InternalHelpers;
 using UnitsNet.Units;
 
 // ReSharper disable once CheckNamespace
@@ -85,17 +82,21 @@ static Acceleration()
         /// <summary>
         ///     Creates the quantity with the given numeric value and unit.
         /// </summary>
-        /// <param name="numericValue">Numeric value.</param>
+        /// <param name="numericValue">The numeric value  to contruct this quantity with.</param>
         /// <param name="unit">The unit representation to contruct this quantity with.</param>
         /// <remarks>Value parameter cannot be named 'value' due to constraint when targeting Windows Runtime Component.</remarks>
+        /// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
 #if WINDOWS_UWP
         private
 #else
         public
 #endif
         Acceleration(double numericValue, AccelerationUnit unit)
         {
-            _value = numericValue;
+            if(unit == AccelerationUnit.Undefined)
+              throw new ArgumentException("The quantity can not be created with an undefined unit.", nameof(unit));
+
+            _value = Guard.EnsureValidNumber(numericValue, nameof(numericValue));
             _unit = unit;
         }
 
@@ -201,6 +202,7 @@ public static BaseDimensions BaseDimensions
         /// <summary>
         ///     Get Acceleration from CentimetersPerSecondSquared.
         /// </summary>
+        /// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
 #if WINDOWS_UWP
         [Windows.Foundation.Metadata.DefaultOverload]
         public static Acceleration FromCentimetersPerSecondSquared(double centimeterspersecondsquared)
@@ -215,6 +217,7 @@ public static Acceleration FromCentimetersPerSecondSquared(QuantityValue centime
         /// <summary>
         ///     Get Acceleration from DecimetersPerSecondSquared.
         /// </summary>
+        /// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
 #if WINDOWS_UWP
         [Windows.Foundation.Metadata.DefaultOverload]
         public static Acceleration FromDecimetersPerSecondSquared(double decimeterspersecondsquared)
@@ -229,6 +232,7 @@ public static Acceleration FromDecimetersPerSecondSquared(QuantityValue decimete
         /// <summary>
         ///     Get Acceleration from FeetPerSecondSquared.
         /// </summary>
+        /// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
 #if WINDOWS_UWP
         [Windows.Foundation.Metadata.DefaultOverload]
         public static Acceleration FromFeetPerSecondSquared(double feetpersecondsquared)
@@ -243,6 +247,7 @@ public static Acceleration FromFeetPerSecondSquared(QuantityValue feetperseconds
         /// <summary>
         ///     Get Acceleration from InchesPerSecondSquared.
         /// </summary>
+        /// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
 #if WINDOWS_UWP
         [Windows.Foundation.Metadata.DefaultOverload]
         public static Acceleration FromInchesPerSecondSquared(double inchespersecondsquared)
@@ -257,6 +262,7 @@ public static Acceleration FromInchesPerSecondSquared(QuantityValue inchespersec
         /// <summary>
         ///     Get Acceleration from KilometersPerSecondSquared.
         /// </summary>
+        /// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
 #if WINDOWS_UWP
         [Windows.Foundation.Metadata.DefaultOverload]
         public static Acceleration FromKilometersPerSecondSquared(double kilometerspersecondsquared)
@@ -271,6 +277,7 @@ public static Acceleration FromKilometersPerSecondSquared(QuantityValue kilomete
         /// <summary>
         ///     Get Acceleration from KnotsPerHour.
         /// </summary>
+        /// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
 #if WINDOWS_UWP
         [Windows.Foundation.Metadata.DefaultOverload]
         public static Acceleration FromKnotsPerHour(double knotsperhour)
@@ -285,6 +292,7 @@ public static Acceleration FromKnotsPerHour(QuantityValue knotsperhour)
         /// <summary>
         ///     Get Acceleration from KnotsPerMinute.
         /// </summary>
+        /// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
 #if WINDOWS_UWP
         [Windows.Foundation.Metadata.DefaultOverload]
         public static Acceleration FromKnotsPerMinute(double knotsperminute)
@@ -299,6 +307,7 @@ public static Acceleration FromKnotsPerMinute(QuantityValue knotsperminute)
         /// <summary>
         ///     Get Acceleration from KnotsPerSecond.
         /// </summary>
+        /// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
 #if WINDOWS_UWP
         [Windows.Foundation.Metadata.DefaultOverload]
         public static Acceleration FromKnotsPerSecond(double knotspersecond)
@@ -313,6 +322,7 @@ public static Acceleration FromKnotsPerSecond(QuantityValue knotspersecond)
         /// <summary>
         ///     Get Acceleration from MetersPerSecondSquared.
         /// </summary>
+        /// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
 #if WINDOWS_UWP
         [Windows.Foundation.Metadata.DefaultOverload]
         public static Acceleration FromMetersPerSecondSquared(double meterspersecondsquared)
@@ -327,6 +337,7 @@ public static Acceleration FromMetersPerSecondSquared(QuantityValue meterspersec
         /// <summary>
         ///     Get Acceleration from MicrometersPerSecondSquared.
         /// </summary>
+        /// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
 #if WINDOWS_UWP
         [Windows.Foundation.Metadata.DefaultOverload]
         public static Acceleration FromMicrometersPerSecondSquared(double micrometerspersecondsquared)
@@ -341,6 +352,7 @@ public static Acceleration FromMicrometersPerSecondSquared(QuantityValue microme
         /// <summary>
         ///     Get Acceleration from MillimetersPerSecondSquared.
         /// </summary>
+        /// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
 #if WINDOWS_UWP
         [Windows.Foundation.Metadata.DefaultOverload]
         public static Acceleration FromMillimetersPerSecondSquared(double millimeterspersecondsquared)
@@ -355,6 +367,7 @@ public static Acceleration FromMillimetersPerSecondSquared(QuantityValue millime
         /// <summary>
         ///     Get Acceleration from NanometersPerSecondSquared.
         /// </summary>
+        /// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
 #if WINDOWS_UWP
         [Windows.Foundation.Metadata.DefaultOverload]
         public static Acceleration FromNanometersPerSecondSquared(double nanometerspersecondsquared)
@@ -369,6 +382,7 @@ public static Acceleration FromNanometersPerSecondSquared(QuantityValue nanomete
         /// <summary>
         ///     Get Acceleration from StandardGravity.
         /// </summary>
+        /// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
 #if WINDOWS_UWP
         [Windows.Foundation.Metadata.DefaultOverload]
         public static Acceleration FromStandardGravity(double standardgravity)
@@ -601,7 +615,7 @@ private double AsBaseNumericType(AccelerationUnit unit)
         /// </exception>
         public static Acceleration Parse(string str)
         {
-            return Parse(str, null);
+            return ParseInternal(str, null);
         }
 
         /// <summary>
@@ -614,7 +628,7 @@ public static Acceleration Parse(string str)
         /// </example>
         public static bool TryParse([CanBeNull] string str, out Acceleration result)
         {
-            return TryParse(str, null, out result);
+            return TryParseInternal(str, null, out result);
         }
 
         /// <summary>
@@ -628,7 +642,121 @@ public static bool TryParse([CanBeNull] string str, out Acceleration result)
         /// <exception cref="UnitsNetException">Error parsing string.</exception>
         public static AccelerationUnit ParseUnit(string str)
         {
-            return ParseUnit(str, (IFormatProvider)null);
+            return ParseUnitInternal(str, null);
+        }
+
+        public static bool TryParseUnit(string str, out AccelerationUnit unit)
+        {
+            return TryParseUnitInternal(str, null, out unit);
+        }
+
+        /// <summary>
+        ///     Parse a string with one or two quantities of the format "&lt;quantity&gt; &lt;unit&gt;".
+        /// </summary>
+        /// <param name="str">String to parse. Typically in the form: {number} {unit}</param>
+        /// <param name="provider">Format to use when parsing number and unit. Defaults to <see cref="GlobalConfiguration.DefaultCulture" />.</param>
+        /// <example>
+        ///     Length.Parse("5.5 m", new CultureInfo("en-US"));
+        /// </example>
+        /// <exception cref="ArgumentNullException">The value of 'str' cannot be null. </exception>
+        /// <exception cref="ArgumentException">
+        ///     Expected string to have one or two pairs of quantity and unit in the format
+        ///     "&lt;quantity&gt; &lt;unit&gt;". Eg. "5.5 m" or "1ft 2in"
+        /// </exception>
+        /// <exception cref="AmbiguousUnitParseException">
+        ///     More than one unit is represented by the specified unit abbreviation.
+        ///     Example: Volume.Parse("1 cup") will throw, because it can refer to any of
+        ///     <see cref="VolumeUnit.MetricCup" />, <see cref="VolumeUnit.UsLegalCup" /> and <see cref="VolumeUnit.UsCustomaryCup" />.
+        /// </exception>
+        /// <exception cref="UnitsNetException">
+        ///     If anything else goes wrong, typically due to a bug or unhandled case.
+        ///     We wrap exceptions in <see cref="UnitsNetException" /> to allow you to distinguish
+        ///     Units.NET exceptions from other exceptions.
+        /// </exception>
+        private static Acceleration ParseInternal(string str, [CanBeNull] IFormatProvider provider)
+        {
+            if (str == null) throw new ArgumentNullException(nameof(str));
+
+            provider = provider ?? GlobalConfiguration.DefaultCulture;
+
+            return QuantityParser.Default.Parse<Acceleration, AccelerationUnit>(str, provider, ParseUnitInternal, From,
+                (x, y) => From(x.MetersPerSecondSquared + y.MetersPerSecondSquared, BaseUnit));
+        }
+
+        /// <summary>
+        ///     Try to parse a string with one or two quantities of the format "&lt;quantity&gt; &lt;unit&gt;".
+        /// </summary>
+        /// <param name="str">String to parse. Typically in the form: {number} {unit}</param>
+        /// <param name="provider">Format to use when parsing number and unit. Defaults to <see cref="GlobalConfiguration.DefaultCulture" />.</param>
+        /// <param name="result">Resulting unit quantity if successful.</param>
+        /// <returns>True if successful, otherwise false.</returns>
+        /// <example>
+        ///     Length.Parse("5.5 m", new CultureInfo("en-US"));
+        /// </example>
+        private static bool TryParseInternal([CanBeNull] string str, [CanBeNull] IFormatProvider provider, out Acceleration result)
+        {
+            result = default(Acceleration);
+
+            if(string.IsNullOrWhiteSpace(str))
+                return false;
+
+            provider = provider ?? GlobalConfiguration.DefaultCulture;
+
+            return QuantityParser.Default.TryParse<Acceleration, AccelerationUnit>(str, provider, TryParseUnitInternal, From,
+                (x, y) => From(x.MetersPerSecondSquared + y.MetersPerSecondSquared, BaseUnit), out result);
+        }
+
+        /// <summary>
+        ///     Parse a unit string.
+        /// </summary>
+        /// <param name="str">String to parse. Typically in the form: {number} {unit}</param>
+        /// <param name="provider">Format to use when parsing number and unit. Defaults to <see cref="GlobalConfiguration.DefaultCulture" />.</param>
+        /// <example>
+        ///     Length.ParseUnit("m", new CultureInfo("en-US"));
+        /// </example>
+        /// <exception cref="ArgumentNullException">The value of 'str' cannot be null. </exception>
+        /// <exception cref="UnitsNetException">Error parsing string.</exception>
+        private static AccelerationUnit ParseUnitInternal(string str, IFormatProvider provider = null)
+        {
+            if (str == null) throw new ArgumentNullException(nameof(str));
+
+            var unit = UnitParser.Default.Parse<AccelerationUnit>(str.Trim(), provider);
+
+            if (unit == AccelerationUnit.Undefined)
+            {
+                var newEx = new UnitsNetException("Error parsing string. The unit is not a recognized AccelerationUnit.");
+                newEx.Data["input"] = str;
+                newEx.Data["provider"] = provider?.ToString() ?? "(null)";
+                throw newEx;
+            }
+
+            return unit;
+        }
+
+        /// <summary>
+        ///     Parse a unit string.
+        /// </summary>
+        /// <param name="str">String to parse. Typically in the form: {number} {unit}</param>
+        /// <param name="provider">Format to use when parsing number and unit. Defaults to <see cref="GlobalConfiguration.DefaultCulture" />.</param>
+        /// <param name="unit">The parsed unit if successful.</param>
+        /// <returns>True if successful, otherwise false.</returns>
+        /// <example>
+        ///     Length.ParseUnit("m", new CultureInfo("en-US"));
+        /// </example>
+        private static bool TryParseUnitInternal(string str, IFormatProvider provider, out AccelerationUnit unit)
+        {
+            unit = AccelerationUnit.Undefined;
+
+            if(string.IsNullOrWhiteSpace(str))
+                return false;
+
+            if(!UnitParser.Default.TryParse<AccelerationUnit>(str.Trim(), provider, out unit))
+                return false;
+
+            if(unit == AccelerationUnit.Undefined)
+                return false;
+
+            return true;
         }
 
         #endregion