forked from angularsen/UnitsNet
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathInclude-GenerateQuantitySourceCodeCommon.ps1
More file actions
826 lines (745 loc) · 35.4 KB
/
Include-GenerateQuantitySourceCodeCommon.ps1
File metadata and controls
826 lines (745 loc) · 35.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
function GenerateQuantitySourceCodeCommon($quantity)
{
$quantityName = $quantity.Name;
$units = $quantity.Units;
$baseType = $quantity.BaseType;
$baseUnit = $units | where { $_.SingularName -eq $quantity.BaseUnit }
$baseUnitSingularName = $baseUnit.SingularName
$baseUnitPluralName = $baseUnit.PluralName
$baseUnitPluralNameLower = $baseUnitPluralName.ToLowerInvariant()
$unitEnumName = "$quantityName" + "Unit"
# Base dimensions
$baseDimensions = $quantity.BaseDimensions;
$baseDimensionLength = if($baseDimensions.L){$baseDimensions.L} else{0};
$baseDimensionMass = if($baseDimensions.M){$baseDimensions.M} else{0};
$baseDimensionTime = if($baseDimensions.T){$baseDimensions.T} else{0};
$baseDimensionElectricCurrent = if($baseDimensions.I){$baseDimensions.I} else{0};
$baseDimensionTemperature = if($baseDimensions.Θ){$baseDimensions.Θ} else{0};
$baseDimensionAmountOfSubstance = if($baseDimensions.N){$baseDimensions.N} else{0};
$baseDimensionLuminousIntensity = if($baseDimensions.J){$baseDimensions.J} else{0};
$convertToBaseType = switch ($baseType) {
"long" { "Convert.ToInt64"; break }
"double" { "Convert.ToDouble"; break }
"decimal" { "Convert.ToDecimal"; break }
default { throw "Base type not supported: $baseType" }
}
$quantityValueType = switch ($baseType) {
"long" { "QuantityValue"; break }
"double" { "QuantityValue"; break }
"decimal" { "QuantityValue"; break }
default { throw "Base type not supported: $baseType" }
}
$obsoleteEqualityIfDouble = ''
if ($quantity.BaseType -eq "double") {
$obsoleteEqualityIfDouble = '[Obsolete("It is not safe to compare equality due to using System.Double as the internal representation. It is very easy to get slightly different values due to floating point operations. Instead use Equals($quantityName, double, ComparisonType) to provide the max allowed absolute or relative error.")]' + "`r`n "
}
@"
//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by \generate-code.bat.
//
// Changes to this file will be lost when the code is regenerated.
// The build server regenerates the code before each build and a pre-build
// step will regenerate the code on each local build.
//
// 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>
//------------------------------------------------------------------------------
// Copyright (c) 2013 Andreas Gullberg Larsen (andreas.larsen84@gmail.com).
// https://github.com/angularsen/UnitsNet
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Text.RegularExpressions;
using System.Linq;
using JetBrains.Annotations;
using UnitsNet.Units;
// ReSharper disable once CheckNamespace
namespace UnitsNet
{
/// <summary>
/// $($quantity.XmlDoc)
/// </summary>
// ReSharper disable once PartialTypeWithSinglePart
// Windows Runtime Component has constraints on public types: https://msdn.microsoft.com/en-us/library/br230301.aspx#Declaring types in Windows Runtime Components
// Public structures can't have any members other than public fields, and those fields must be value types or strings.
// Public classes must be sealed (NotInheritable in Visual Basic). If your programming model requires polymorphism, you can create a public interface and implement that interface on the classes that must be polymorphic.
#if WINDOWS_UWP
public sealed partial class $quantityName
#else
public partial struct $quantityName : IComparable, IComparable<$quantityName>
#endif
{
/// <summary>
/// The numeric value this quantity was constructed with.
/// </summary>
private readonly $baseType _value;
/// <summary>
/// The unit this quantity was constructed with.
/// </summary>
private readonly $($unitEnumName)? _unit;
/// <summary>
/// The unit this quantity was constructed with -or- <see cref="BaseUnit" /> if default ctor was used.
/// </summary>
public $unitEnumName Unit => _unit.GetValueOrDefault(BaseUnit);
[Obsolete("Use the constructor that takes a unit parameter. This constructor will be removed in a future version.")]
public $quantityName(double $baseUnitPluralNameLower)
{
_value = $convertToBaseType($baseUnitPluralNameLower);
_unit = BaseUnit;
}
/// <summary>
/// Creates the quantity with the given numeric value and unit.
/// </summary>
/// <param name="numericValue">Numeric value.</param>
/// <param name="unit">Unit representation.</param>
/// <remarks>Value parameter cannot be named 'value' due to constraint when targeting Windows Runtime Component.</remarks>
#if WINDOWS_UWP
private
#else
public
#endif
$quantityName($baseType numericValue, $unitEnumName unit)
{
_value = numericValue;
_unit = unit;
}
// Windows Runtime Component does not allow public methods/ctors with same number of parameters: https://msdn.microsoft.com/en-us/library/br230301.aspx#Overloaded methods
/// <summary>
/// Creates the quantity with the given value assuming the base unit $baseUnitSingularName.
/// </summary>
/// <param name="$baseUnitPluralNameLower">Value assuming base unit $baseUnitSingularName.</param>
#if WINDOWS_UWP
private
#else
[Obsolete("Use the constructor that takes a unit parameter. This constructor will be removed in a future version.")]
public
#endif
$quantityName(long $baseUnitPluralNameLower) : this($convertToBaseType($baseUnitPluralNameLower), BaseUnit) { }
// Windows Runtime Component does not allow public methods/ctors with same number of parameters: https://msdn.microsoft.com/en-us/library/br230301.aspx#Overloaded methods
// Windows Runtime Component does not support decimal type
/// <summary>
/// Creates the quantity with the given value assuming the base unit $baseUnitSingularName.
/// </summary>
/// <param name="$baseUnitPluralNameLower">Value assuming base unit $baseUnitSingularName.</param>
#if WINDOWS_UWP
private
#else
[Obsolete("Use the constructor that takes a unit parameter. This constructor will be removed in a future version.")]
public
#endif
$quantityName(decimal $baseUnitPluralNameLower) : this($convertToBaseType($baseUnitPluralNameLower), BaseUnit) { }
#region Properties
/// <summary>
/// The <see cref="QuantityType" /> of this quantity.
/// </summary>
public static QuantityType QuantityType => QuantityType.$quantityName;
/// <summary>
/// The base unit representation of this quantity for the numeric value stored internally. All conversions go via this value.
/// </summary>
public static $unitEnumName BaseUnit => $unitEnumName.$baseUnitSingularName;
"@;
if($baseDimensions)
{
@"
private static readonly BaseDimensions _baseDimensions = new BaseDimensions($baseDimensionLength, $baseDimensionMass, $baseDimensionTime, $baseDimensionElectricCurrent, $baseDimensionTemperature, $baseDimensionAmountOfSubstance, $baseDimensionLuminousIntensity);
/// <summary>
/// The <see cref="BaseDimensions" /> of this quantity.
/// </summary>
public static BaseDimensions BaseDimensions
{
get{ return _baseDimensions; }
}
"@;
}
@"
/// <summary>
/// All units of measurement for the $quantityName quantity.
/// </summary>
public static $unitEnumName[] Units { get; } = Enum.GetValues(typeof($unitEnumName)).Cast<$unitEnumName>().ToArray();
"@;
foreach ($unit in $units) {
$propertyName = $unit.PluralName;
$obsoleteAttribute = GetObsoleteAttribute($unit);
if ($obsoleteAttribute)
{
$obsoleteAttribute = "`r`n " + $obsoleteAttribute; # apply padding to conformance with code format in this page
}
@"
/// <summary>
/// Get $quantityName in $propertyName.
/// </summary>$($obsoleteAttribute)
public double $propertyName => As($unitEnumName.$($unit.SingularName));
"@; }@"
#endregion
#region Static
public static $quantityName Zero => new $quantityName(0, BaseUnit);
"@; foreach ($unit in $units) {
$valueParamName = $unit.PluralName.ToLowerInvariant();@"
/// <summary>
/// Get $quantityName from $($unit.PluralName).
/// </summary>
#if WINDOWS_UWP
[Windows.Foundation.Metadata.DefaultOverload]
public static $quantityName From$($unit.PluralName)(double $valueParamName)
#else
public static $quantityName From$($unit.PluralName)($quantityValueType $valueParamName)
#endif
{
$baseType value = ($baseType) $valueParamName;
return new $quantityName(value, $unitEnumName.$($unit.SingularName));
}
"@; }@"
/// <summary>
/// Dynamically convert from value and unit enum <see cref="$unitEnumName" /> to <see cref="$quantityName" />.
/// </summary>
/// <param name="value">Value to convert from.</param>
/// <param name="fromUnit">Unit to convert from.</param>
/// <returns>$quantityName unit value.</returns>
#if WINDOWS_UWP
// Fix name conflict with parameter "value"
[return: System.Runtime.InteropServices.WindowsRuntime.ReturnValueName("returnValue")]
public static $quantityName From(double value, $unitEnumName fromUnit)
#else
public static $quantityName From($quantityValueType value, $unitEnumName fromUnit)
#endif
{
return new $quantityName(($baseType)value, fromUnit);
}
/// <summary>
/// Get unit abbreviation string.
/// </summary>
/// <param name="unit">Unit to get abbreviation for.</param>
/// <returns>Unit abbreviation string.</returns>
[UsedImplicitly]
public static string GetAbbreviation($unitEnumName unit)
{
return GetAbbreviation(unit, null);
}
/// <summary>
/// Get unit abbreviation string.
/// </summary>
/// <param name="unit">Unit to get abbreviation for.</param>
#if WINDOWS_UWP
/// <param name="cultureName">Name of culture (ex: "en-US") to use for localization. Defaults to <see cref="UnitSystem" />'s default culture.</param>
#else
/// <param name="provider">Format to use for localization. Defaults to <see cref="UnitSystem.DefaultCulture" />.</param>
#endif
/// <returns>Unit abbreviation string.</returns>
[UsedImplicitly]
public static string GetAbbreviation(
$unitEnumName unit,
#if WINDOWS_UWP
[CanBeNull] string cultureName)
#else
[CanBeNull] IFormatProvider provider)
#endif
{
#if WINDOWS_UWP
// Windows Runtime Component does not support CultureInfo and IFormatProvider types, so we use culture name for public methods: https://msdn.microsoft.com/en-us/library/br230301.aspx
IFormatProvider provider = cultureName == null ? UnitSystem.DefaultCulture : new CultureInfo(cultureName);
#else
provider = provider ?? UnitSystem.DefaultCulture;
#endif
return UnitSystem.GetCached(provider).GetDefaultAbbreviation(unit);
}
#endregion
#region Equality / IComparable
public int CompareTo(object obj)
{
if(obj is null) throw new ArgumentNullException(nameof(obj));
if(!(obj is $quantityName)) throw new ArgumentException("Expected type $quantityName.", nameof(obj));
return CompareTo(($quantityName)obj);
}
// Windows Runtime Component does not allow public methods/ctors with same number of parameters: https://msdn.microsoft.com/en-us/library/br230301.aspx#Overloaded methods
#if WINDOWS_UWP
internal
#else
public
#endif
int CompareTo($quantityName other)
{
return _value.CompareTo(other.AsBaseNumericType(this.Unit));
}
$($obsoleteEqualityIfDouble)public override bool Equals(object obj)
{
if(obj is null || !(obj is $quantityName))
return false;
var objQuantity = ($quantityName)obj;
return _value.Equals(objQuantity.AsBaseNumericType(this.Unit));
}
/// <summary>
/// <para>
/// Compare equality to another $quantityName within the given absolute or relative tolerance.
/// </para>
/// <para>
/// Relative tolerance is defined as the maximum allowable absolute difference between this quantity's value and
/// <paramref name="other"/> as a percentage of this quantity's value. <paramref name="other"/> will be converted into
/// this quantity's unit for comparison. A relative tolerance of 0.01 means the absolute difference must be within +/- 1% of
/// this quantity's value to be considered equal.
/// <example>
/// In this example, the two quantities will be equal if the value of b is within +/- 1% of a (0.02m or 2cm).
/// <code>
/// var a = Length.FromMeters(2.0);
/// var b = Length.FromInches(50.0);
/// a.Equals(b, 0.01, ComparisonType.Relative);
/// </code>
/// </example>
/// </para>
/// <para>
/// Absolute tolerance is defined as the maximum allowable absolute difference between this quantity's value and
/// <paramref name="other"/> as a fixed number in this quantity's unit. <paramref name="other"/> will be converted into
/// this quantity's unit for comparison.
/// <example>
/// In this example, the two quantities will be equal if the value of b is within 0.01 of a (0.01m or 1cm).
/// <code>
/// var a = Length.FromMeters(2.0);
/// var b = Length.FromInches(50.0);
/// a.Equals(b, 0.01, ComparisonType.Absolute);
/// </code>
/// </example>
/// </para>
/// <para>
/// Note that it is advised against specifying zero difference, due to the nature
/// of floating point operations and using System.Double internally.
/// </para>
/// </summary>
/// <param name="other">The other quantity to compare to.</param>
/// <param name="tolerance">The absolute or relative tolerance value. Must be greater than or equal to 0.</param>
/// <param name="comparisonType">The comparison type: either relative or absolute.</param>
/// <returns>True if the absolute difference between the two values is not greater than the specified relative or absolute tolerance.</returns>
public bool Equals($quantityName other, double tolerance, ComparisonType comparisonType)
{
if(tolerance < 0)
throw new ArgumentOutOfRangeException("tolerance", "Tolerance must be greater than or equal to 0.");
double thisValue = (double)this.Value;
double otherValueInThisUnits = other.As(this.Unit);
return UnitsNet.Comparison.Equals(thisValue, otherValueInThisUnits, tolerance, comparisonType);
}
/// <summary>
/// Compare equality to another $quantityName by specifying a max allowed difference.
/// Note that it is advised against specifying zero difference, due to the nature
/// of floating point operations and using System.Double internally.
/// </summary>
/// <param name="other">Other quantity to compare to.</param>
/// <param name="maxError">Max error allowed.</param>
/// <returns>True if the difference between the two values is not greater than the specified max.</returns>
[Obsolete("Please use the Equals($quantityName, double, ComparisonType) overload. This method will be removed in a future version.")]
public bool Equals($quantityName other, $quantityName maxError)
{
return Math.Abs(_value - other.AsBaseNumericType(this.Unit)) <= maxError.AsBaseNumericType(this.Unit);
}
public override int GetHashCode()
{
return new { Value, Unit }.GetHashCode();
}
#endregion
#region Conversion
/// <summary>
/// Convert to the unit representation <paramref name="unit" />.
/// </summary>
/// <returns>Value converted to the specified unit.</returns>
public double As($unitEnumName unit)
{
if(Unit == unit)
return Convert.ToDouble(Value);
var converted = AsBaseNumericType(unit);
return Convert.ToDouble(converted);
}
/// <summary>
/// Converts this $quantityName to another $quantityName with the unit representation <paramref name="unit" />.
/// </summary>
/// <returns>A $quantityName with the specified unit.</returns>
public $quantityName ToUnit($unitEnumName unit)
{
var convertedValue = AsBaseNumericType(unit);
return new $quantityName(convertedValue, unit);
}
/// <summary>
/// Converts the current value + unit to the base unit.
/// This is typically the first step in converting from one unit to another.
/// </summary>
/// <returns>The value in the base unit representation.</returns>
private $baseType AsBaseUnit()
{
switch(Unit)
{
"@; foreach ($unit in $units) {
$func = $unit.FromUnitToBaseFunc.Replace("x", "_value");@"
case $unitEnumName.$($unit.SingularName): return $func;
"@; }@"
default:
throw new NotImplementedException($"Can not convert {Unit} to base units.");
}
}
private $baseType AsBaseNumericType($unitEnumName unit)
{
if(Unit == unit)
return _value;
var baseUnitValue = AsBaseUnit();
switch(unit)
{
"@; foreach ($unit in $units) {
$func = $unit.FromBaseToUnitFunc.Replace("x", "baseUnitValue");@"
case $unitEnumName.$($unit.SingularName): return $func;
"@; }@"
default:
throw new NotImplementedException($"Can not convert {Unit} to {unit}.");
}
}
#endregion
#region Parsing
/// <summary>
/// Parse a string with one or two quantities of the format "<quantity> <unit>".
/// </summary>
/// <param name="str">String to parse. Typically in the form: {number} {unit}</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
/// "<quantity> <unit>". 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>
public static $quantityName Parse(string str)
{
return Parse(str, null);
}
/// <summary>
/// Parse a string with one or two quantities of the format "<quantity> <unit>".
/// </summary>
/// <param name="str">String to parse. Typically in the form: {number} {unit}</param>
#if WINDOWS_UWP
/// <param name="cultureName">Name of culture (ex: "en-US") to use when parsing number and unit. Defaults to <see cref="UnitSystem" />'s default culture.</param>
#else
/// <param name="provider">Format to use when parsing number and unit. Defaults to <see cref="UnitSystem.DefaultCulture" />.</param>
#endif
/// <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
/// "<quantity> <unit>". 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>
public static $quantityName Parse(
string str,
#if WINDOWS_UWP
[CanBeNull] string cultureName)
#else
[CanBeNull] IFormatProvider provider)
#endif
{
if (str == null) throw new ArgumentNullException(nameof(str));
#if WINDOWS_UWP
// Windows Runtime Component does not support CultureInfo and IFormatProvider types, so we use culture name for public methods: https://msdn.microsoft.com/en-us/library/br230301.aspx
IFormatProvider provider = cultureName == null ? UnitSystem.DefaultCulture : new CultureInfo(cultureName);
#else
provider = provider ?? UnitSystem.DefaultCulture;
#endif
return QuantityParser.Parse<$quantityName, $unitEnumName>(str, provider,
delegate(string value, string unit, IFormatProvider formatProvider2)
{
double parsedValue = double.Parse(value, formatProvider2);
$unitEnumName parsedUnit = ParseUnit(unit, formatProvider2);
return From(parsedValue, parsedUnit);
}, (x, y) => From$baseUnitPluralName(x.$baseUnitPluralName + y.$baseUnitPluralName));
}
/// <summary>
/// Try to parse a string with one or two quantities of the format "<quantity> <unit>".
/// </summary>
/// <param name="str">String to parse. Typically in the form: {number} {unit}</param>
/// <param name="result">Resulting unit quantity if successful.</param>
/// <example>
/// Length.Parse("5.5 m", new CultureInfo("en-US"));
/// </example>
public static bool TryParse([CanBeNull] string str, out $quantityName result)
{
return TryParse(str, null, out result);
}
/// <summary>
/// Try to parse a string with one or two quantities of the format "<quantity> <unit>".
/// </summary>
/// <param name="str">String to parse. Typically in the form: {number} {unit}</param>
#if WINDOWS_UWP
/// <param name="cultureName">Name of culture (ex: "en-US") to use when parsing number and unit. Defaults to <see cref="UnitSystem" />'s default culture.</param>
#else
/// <param name="provider">Format to use when parsing number and unit. Defaults to <see cref="UnitSystem.DefaultCulture" />.</param>
#endif
/// <param name="result">Resulting unit quantity if successful.</param>
/// <example>
/// Length.Parse("5.5 m", new CultureInfo("en-US"));
/// </example>
public static bool TryParse(
[CanBeNull] string str,
#if WINDOWS_UWP
[CanBeNull] string cultureName,
#else
[CanBeNull] IFormatProvider provider,
#endif
out $quantityName result)
{
#if WINDOWS_UWP
// Windows Runtime Component does not support CultureInfo and IFormatProvider types, so we use culture name for public methods: https://msdn.microsoft.com/en-us/library/br230301.aspx
IFormatProvider provider = cultureName == null ? UnitSystem.DefaultCulture : new CultureInfo(cultureName);
#else
provider = provider ?? UnitSystem.DefaultCulture;
#endif
try
{
result = Parse(
str,
#if WINDOWS_UWP
cultureName);
#else
provider);
#endif
return true;
}
catch
{
result = default($quantityName);
return false;
}
}
/// <summary>
/// Parse a unit string.
/// </summary>
/// <param name="str">String to parse. Typically in the form: {number} {unit}</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>
public static $unitEnumName ParseUnit(string str)
{
return ParseUnit(str, (IFormatProvider)null);
}
/// <summary>
/// Parse a unit string.
/// </summary>
/// <param name="str">String to parse. Typically in the form: {number} {unit}</param>
/// <param name="cultureName">Name of culture (ex: "en-US") to use when parsing number and unit. Defaults to <see cref="UnitSystem" />'s default culture.</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>
[Obsolete("Use overload that takes IFormatProvider instead of culture name. This method was only added to support WindowsRuntimeComponent and will be removed from other .NET targets.")]
public static $unitEnumName ParseUnit(string str, [CanBeNull] string cultureName)
{
return ParseUnit(str, cultureName == null ? null : new CultureInfo(cultureName));
}
/// <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="UnitSystem.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>
// Windows Runtime Component does not allow public methods/ctors with same number of parameters: https://msdn.microsoft.com/en-us/library/br230301.aspx#Overloaded methods
#if WINDOWS_UWP
internal
#else
public
#endif
static $unitEnumName ParseUnit(string str, IFormatProvider provider = null)
{
if (str == null) throw new ArgumentNullException(nameof(str));
var unitSystem = UnitSystem.GetCached(provider);
var unit = unitSystem.Parse<$unitEnumName>(str.Trim());
if (unit == $unitEnumName.Undefined)
{
var newEx = new UnitsNetException("Error parsing string. The unit is not a recognized $unitEnumName.");
newEx.Data["input"] = str;
newEx.Data["provider"] = provider?.ToString() ?? "(null)";
throw newEx;
}
return unit;
}
#endregion
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
/// <summary>
/// Set the default unit used by ToString(). Default is $baseUnitSingularName
/// </summary>
public static $unitEnumName ToStringDefaultUnit { get; set; } = $unitEnumName.$baseUnitSingularName;
/// <summary>
/// Get default string representation of value and unit.
/// </summary>
/// <returns>String representation.</returns>
public override string ToString()
{
return ToString(Unit);
}
/// <summary>
/// Get string representation of value and unit. Using current UI culture and two significant digits after radix.
/// </summary>
/// <param name="unit">Unit representation to use.</param>
/// <returns>String representation.</returns>
public string ToString($unitEnumName unit)
{
return ToString(unit, null, 2);
}
/// <summary>
/// Get string representation of value and unit. Using two significant digits after radix.
/// </summary>
/// <param name="unit">Unit representation to use.</param>
#if WINDOWS_UWP
/// <param name="cultureName">Name of culture (ex: "en-US") to use for localization and number formatting. Defaults to <see cref="UnitSystem" />'s default culture.</param>
#else
/// <param name="provider">Format to use for localization and number formatting. Defaults to <see cref="UnitSystem.DefaultCulture" />.</param>
#endif
/// <returns>String representation.</returns>
public string ToString(
$unitEnumName unit,
#if WINDOWS_UWP
[CanBeNull] string cultureName)
#else
[CanBeNull] IFormatProvider provider)
#endif
{
return ToString(
unit,
#if WINDOWS_UWP
cultureName,
#else
provider,
#endif
2);
}
/// <summary>
/// Get string representation of value and unit.
/// </summary>
/// <param name="unit">Unit representation to use.</param>
#if WINDOWS_UWP
/// <param name="cultureName">Name of culture (ex: "en-US") to use for localization and number formatting. Defaults to <see cref="UnitSystem" />'s default culture.</param>
#else
/// <param name="provider">Format to use for localization and number formatting. Defaults to <see cref="UnitSystem.DefaultCulture" />.</param>
#endif
/// <param name="significantDigitsAfterRadix">The number of significant digits after the radix point.</param>
/// <returns>String representation.</returns>
[UsedImplicitly]
public string ToString(
$unitEnumName unit,
#if WINDOWS_UWP
[CanBeNull] string cultureName,
#else
[CanBeNull] IFormatProvider provider,
#endif
int significantDigitsAfterRadix)
{
double value = As(unit);
string format = UnitFormatter.GetFormat(value, significantDigitsAfterRadix);
return ToString(
unit,
#if WINDOWS_UWP
cultureName,
#else
provider,
#endif
format);
}
/// <summary>
/// Get string representation of value and unit.
/// </summary>
#if WINDOWS_UWP
/// <param name="cultureName">Name of culture (ex: "en-US") to use for localization and number formatting. Defaults to <see cref="UnitSystem" />'s default culture.</param>
#else
/// <param name="provider">Format to use for localization and number formatting. Defaults to <see cref="UnitSystem.DefaultCulture" />.</param>
#endif
/// <param name="unit">Unit representation to use.</param>
/// <param name="format">String format to use. Default: "{0:0.##} {1} for value and unit abbreviation respectively."</param>
/// <param name="args">Arguments for string format. Value and unit are implictly included as arguments 0 and 1.</param>
/// <returns>String representation.</returns>
[UsedImplicitly]
public string ToString(
$unitEnumName unit,
#if WINDOWS_UWP
[CanBeNull] string cultureName,
#else
[CanBeNull] IFormatProvider provider,
#endif
[NotNull] string format,
[NotNull] params object[] args)
{
if (format == null) throw new ArgumentNullException(nameof(format));
if (args == null) throw new ArgumentNullException(nameof(args));
#if WINDOWS_UWP
// Windows Runtime Component does not support CultureInfo and IFormatProvider types, so we use culture name for public methods: https://msdn.microsoft.com/en-us/library/br230301.aspx
IFormatProvider provider = cultureName == null ? UnitSystem.DefaultCulture : new CultureInfo(cultureName);
#else
provider = provider ?? UnitSystem.DefaultCulture;
#endif
double value = As(unit);
object[] formatArgs = UnitFormatter.GetFormatArgs(unit, value, provider, args);
return string.Format(provider, format, formatArgs);
}
/// <summary>
/// Represents the largest possible value of $quantityName
/// </summary>
public static $quantityName MaxValue => new $quantityName($baseType.MaxValue, BaseUnit);
/// <summary>
/// Represents the smallest possible value of $quantityName
/// </summary>
public static $quantityName MinValue => new $quantityName($baseType.MinValue, BaseUnit);
"@;
if($baseDimensions)
{
@"
/// <summary>
/// The <see cref="BaseDimensions" /> of this quantity.
/// </summary>
public BaseDimensions Dimensions => $quantityName.BaseDimensions;
"@;
}
@"
}
}
"@;
}