forked from angularsen/UnitsNet
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathEnergy.g.cs
More file actions
1175 lines (1061 loc) · 51.7 KB
/
Energy.g.cs
File metadata and controls
1175 lines (1061 loc) · 51.7 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
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//------------------------------------------------------------------------------
// <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 UnitDefinitions\MyQuantity.json and run generate-code.bat to generate new units or quantities.
//
// </auto-generated>
//------------------------------------------------------------------------------
// Licensed under MIT No Attribution, see LICENSE file at the root.
// Copyright 2013 Andreas Gullberg Larsen (andreas.larsen84@gmail.com). Maintained at https://github.com/angularsen/UnitsNet.
using System;
using System.Globalization;
using System.Linq;
using JetBrains.Annotations;
using UnitsNet.Units;
using UnitsNet.InternalHelpers;
// ReSharper disable once CheckNamespace
namespace UnitsNet
{
/// <summary>
/// The joule, symbol J, is a derived unit of energy, work, or amount of heat in the International System of Units. It is equal to the energy transferred (or work done) when applying a force of one newton through a distance of one metre (1 newton metre or N·m), or in passing an electric current of one ampere through a resistance of one ohm for one second. Many other units of energy are included. Please do not confuse this definition of the calorie with the one colloquially used by the food industry, the large calorie, which is equivalent to 1 kcal. Thermochemical definition of the calorie is used. For BTU, the IT definition is used.
/// </summary>
// 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.
public sealed partial class Energy : IQuantity
{
/// <summary>
/// The numeric value this quantity was constructed with.
/// </summary>
private readonly double _value;
/// <summary>
/// The unit this quantity was constructed with.
/// </summary>
private readonly EnergyUnit? _unit;
static Energy()
{
BaseDimensions = new BaseDimensions(2, 1, -2, 0, 0, 0, 0, 0);
Info = new QuantityInfo(QuantityType.Energy, Units.Cast<Enum>().ToArray(), BaseUnit, Zero, BaseDimensions);
}
/// <summary>
/// Creates the quantity with a value of 0 in the base unit Joule.
/// </summary>
/// <remarks>
/// Windows Runtime Component requires a default constructor.
/// </remarks>
public Energy()
{
_value = 0;
_unit = BaseUnit;
}
/// <summary>
/// Creates the quantity with the given numeric value and unit.
/// </summary>
/// <param name="value">The numeric value to construct this quantity with.</param>
/// <param name="unit">The unit representation to construct 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>
private Energy(double value, EnergyUnit unit)
{
if(unit == EnergyUnit.Undefined)
throw new ArgumentException("The quantity can not be created with an undefined unit.", nameof(unit));
_value = Guard.EnsureValidNumber(value, nameof(value));
_unit = unit;
}
#region Static Properties
/// <summary>
/// Information about the quantity type, such as unit values and names.
/// </summary>
internal static QuantityInfo Info { get; }
/// <summary>
/// The <see cref="BaseDimensions" /> of this quantity.
/// </summary>
public static BaseDimensions BaseDimensions { get; }
/// <summary>
/// The base unit of Energy, which is Joule. All conversions go via this value.
/// </summary>
public static EnergyUnit BaseUnit { get; } = EnergyUnit.Joule;
/// <summary>
/// Represents the largest possible value of Energy
/// </summary>
public static Energy MaxValue { get; } = new Energy(double.MaxValue, BaseUnit);
/// <summary>
/// Represents the smallest possible value of Energy
/// </summary>
public static Energy MinValue { get; } = new Energy(double.MinValue, BaseUnit);
/// <summary>
/// The <see cref="QuantityType" /> of this quantity.
/// </summary>
public static QuantityType QuantityType { get; } = QuantityType.Energy;
/// <summary>
/// All units of measurement for the Energy quantity.
/// </summary>
public static EnergyUnit[] Units { get; } = Enum.GetValues(typeof(EnergyUnit)).Cast<EnergyUnit>().Except(new EnergyUnit[]{ EnergyUnit.Undefined }).ToArray();
/// <summary>
/// Gets an instance of this quantity with a value of 0 in the base unit Joule.
/// </summary>
public static Energy Zero { get; } = new Energy(0, BaseUnit);
#endregion
#region Properties
/// <summary>
/// The numeric value this quantity was constructed with.
/// </summary>
public double Value => Convert.ToDouble(_value);
/// <inheritdoc cref="IQuantity.Unit"/>
object IQuantity.Unit => Unit;
/// <summary>
/// The unit this quantity was constructed with -or- <see cref="BaseUnit" /> if default ctor was used.
/// </summary>
public EnergyUnit Unit => _unit.GetValueOrDefault(BaseUnit);
internal QuantityInfo QuantityInfo => Info;
/// <summary>
/// The <see cref="QuantityType" /> of this quantity.
/// </summary>
public QuantityType Type => Energy.QuantityType;
/// <summary>
/// The <see cref="BaseDimensions" /> of this quantity.
/// </summary>
public BaseDimensions Dimensions => Energy.BaseDimensions;
#endregion
#region Conversion Properties
/// <summary>
/// Get Energy in BritishThermalUnits.
/// </summary>
public double BritishThermalUnits => As(EnergyUnit.BritishThermalUnit);
/// <summary>
/// Get Energy in Calories.
/// </summary>
public double Calories => As(EnergyUnit.Calorie);
/// <summary>
/// Get Energy in DecathermsEc.
/// </summary>
public double DecathermsEc => As(EnergyUnit.DecathermEc);
/// <summary>
/// Get Energy in DecathermsImperial.
/// </summary>
public double DecathermsImperial => As(EnergyUnit.DecathermImperial);
/// <summary>
/// Get Energy in DecathermsUs.
/// </summary>
public double DecathermsUs => As(EnergyUnit.DecathermUs);
/// <summary>
/// Get Energy in ElectronVolts.
/// </summary>
public double ElectronVolts => As(EnergyUnit.ElectronVolt);
/// <summary>
/// Get Energy in Ergs.
/// </summary>
public double Ergs => As(EnergyUnit.Erg);
/// <summary>
/// Get Energy in FootPounds.
/// </summary>
public double FootPounds => As(EnergyUnit.FootPound);
/// <summary>
/// Get Energy in GigabritishThermalUnits.
/// </summary>
public double GigabritishThermalUnits => As(EnergyUnit.GigabritishThermalUnit);
/// <summary>
/// Get Energy in GigaelectronVolts.
/// </summary>
public double GigaelectronVolts => As(EnergyUnit.GigaelectronVolt);
/// <summary>
/// Get Energy in Gigajoules.
/// </summary>
public double Gigajoules => As(EnergyUnit.Gigajoule);
/// <summary>
/// Get Energy in GigawattDays.
/// </summary>
public double GigawattDays => As(EnergyUnit.GigawattDay);
/// <summary>
/// Get Energy in GigawattHours.
/// </summary>
public double GigawattHours => As(EnergyUnit.GigawattHour);
/// <summary>
/// Get Energy in HorsepowerHours.
/// </summary>
public double HorsepowerHours => As(EnergyUnit.HorsepowerHour);
/// <summary>
/// Get Energy in Joules.
/// </summary>
public double Joules => As(EnergyUnit.Joule);
/// <summary>
/// Get Energy in KilobritishThermalUnits.
/// </summary>
public double KilobritishThermalUnits => As(EnergyUnit.KilobritishThermalUnit);
/// <summary>
/// Get Energy in Kilocalories.
/// </summary>
public double Kilocalories => As(EnergyUnit.Kilocalorie);
/// <summary>
/// Get Energy in KiloelectronVolts.
/// </summary>
public double KiloelectronVolts => As(EnergyUnit.KiloelectronVolt);
/// <summary>
/// Get Energy in Kilojoules.
/// </summary>
public double Kilojoules => As(EnergyUnit.Kilojoule);
/// <summary>
/// Get Energy in KilowattDays.
/// </summary>
public double KilowattDays => As(EnergyUnit.KilowattDay);
/// <summary>
/// Get Energy in KilowattHours.
/// </summary>
public double KilowattHours => As(EnergyUnit.KilowattHour);
/// <summary>
/// Get Energy in MegabritishThermalUnits.
/// </summary>
public double MegabritishThermalUnits => As(EnergyUnit.MegabritishThermalUnit);
/// <summary>
/// Get Energy in Megacalories.
/// </summary>
public double Megacalories => As(EnergyUnit.Megacalorie);
/// <summary>
/// Get Energy in MegaelectronVolts.
/// </summary>
public double MegaelectronVolts => As(EnergyUnit.MegaelectronVolt);
/// <summary>
/// Get Energy in Megajoules.
/// </summary>
public double Megajoules => As(EnergyUnit.Megajoule);
/// <summary>
/// Get Energy in MegawattDays.
/// </summary>
public double MegawattDays => As(EnergyUnit.MegawattDay);
/// <summary>
/// Get Energy in MegawattHours.
/// </summary>
public double MegawattHours => As(EnergyUnit.MegawattHour);
/// <summary>
/// Get Energy in Millijoules.
/// </summary>
public double Millijoules => As(EnergyUnit.Millijoule);
/// <summary>
/// Get Energy in TeraelectronVolts.
/// </summary>
public double TeraelectronVolts => As(EnergyUnit.TeraelectronVolt);
/// <summary>
/// Get Energy in TerawattDays.
/// </summary>
public double TerawattDays => As(EnergyUnit.TerawattDay);
/// <summary>
/// Get Energy in TerawattHours.
/// </summary>
public double TerawattHours => As(EnergyUnit.TerawattHour);
/// <summary>
/// Get Energy in ThermsEc.
/// </summary>
public double ThermsEc => As(EnergyUnit.ThermEc);
/// <summary>
/// Get Energy in ThermsImperial.
/// </summary>
public double ThermsImperial => As(EnergyUnit.ThermImperial);
/// <summary>
/// Get Energy in ThermsUs.
/// </summary>
public double ThermsUs => As(EnergyUnit.ThermUs);
/// <summary>
/// Get Energy in WattDays.
/// </summary>
public double WattDays => As(EnergyUnit.WattDay);
/// <summary>
/// Get Energy in WattHours.
/// </summary>
public double WattHours => As(EnergyUnit.WattHour);
#endregion
#region Static Methods
/// <summary>
/// Get unit abbreviation string.
/// </summary>
/// <param name="unit">Unit to get abbreviation for.</param>
/// <returns>Unit abbreviation string.</returns>
public static string GetAbbreviation(EnergyUnit unit)
{
return GetAbbreviation(unit, null);
}
/// <summary>
/// Get unit abbreviation string.
/// </summary>
/// <param name="unit">Unit to get abbreviation for.</param>
/// <returns>Unit abbreviation string.</returns>
/// <param name="cultureName">Name of culture (ex: "en-US") to use when parsing number and unit. Defaults to <see cref="GlobalConfiguration.DefaultCulture" /> if null.</param>
public static string GetAbbreviation(EnergyUnit unit, [CanBeNull] string cultureName)
{
IFormatProvider provider = GetFormatProviderFromCultureName(cultureName);
return UnitAbbreviationsCache.Default.GetDefaultAbbreviation(unit, provider);
}
#endregion
#region Static Factory Methods
/// <summary>
/// Get Energy from BritishThermalUnits.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromBritishThermalUnits(double britishthermalunits)
{
double value = (double) britishthermalunits;
return new Energy(value, EnergyUnit.BritishThermalUnit);
}
/// <summary>
/// Get Energy from Calories.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromCalories(double calories)
{
double value = (double) calories;
return new Energy(value, EnergyUnit.Calorie);
}
/// <summary>
/// Get Energy from DecathermsEc.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromDecathermsEc(double decathermsec)
{
double value = (double) decathermsec;
return new Energy(value, EnergyUnit.DecathermEc);
}
/// <summary>
/// Get Energy from DecathermsImperial.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromDecathermsImperial(double decathermsimperial)
{
double value = (double) decathermsimperial;
return new Energy(value, EnergyUnit.DecathermImperial);
}
/// <summary>
/// Get Energy from DecathermsUs.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromDecathermsUs(double decathermsus)
{
double value = (double) decathermsus;
return new Energy(value, EnergyUnit.DecathermUs);
}
/// <summary>
/// Get Energy from ElectronVolts.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromElectronVolts(double electronvolts)
{
double value = (double) electronvolts;
return new Energy(value, EnergyUnit.ElectronVolt);
}
/// <summary>
/// Get Energy from Ergs.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromErgs(double ergs)
{
double value = (double) ergs;
return new Energy(value, EnergyUnit.Erg);
}
/// <summary>
/// Get Energy from FootPounds.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromFootPounds(double footpounds)
{
double value = (double) footpounds;
return new Energy(value, EnergyUnit.FootPound);
}
/// <summary>
/// Get Energy from GigabritishThermalUnits.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromGigabritishThermalUnits(double gigabritishthermalunits)
{
double value = (double) gigabritishthermalunits;
return new Energy(value, EnergyUnit.GigabritishThermalUnit);
}
/// <summary>
/// Get Energy from GigaelectronVolts.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromGigaelectronVolts(double gigaelectronvolts)
{
double value = (double) gigaelectronvolts;
return new Energy(value, EnergyUnit.GigaelectronVolt);
}
/// <summary>
/// Get Energy from Gigajoules.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromGigajoules(double gigajoules)
{
double value = (double) gigajoules;
return new Energy(value, EnergyUnit.Gigajoule);
}
/// <summary>
/// Get Energy from GigawattDays.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromGigawattDays(double gigawattdays)
{
double value = (double) gigawattdays;
return new Energy(value, EnergyUnit.GigawattDay);
}
/// <summary>
/// Get Energy from GigawattHours.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromGigawattHours(double gigawatthours)
{
double value = (double) gigawatthours;
return new Energy(value, EnergyUnit.GigawattHour);
}
/// <summary>
/// Get Energy from HorsepowerHours.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromHorsepowerHours(double horsepowerhours)
{
double value = (double) horsepowerhours;
return new Energy(value, EnergyUnit.HorsepowerHour);
}
/// <summary>
/// Get Energy from Joules.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromJoules(double joules)
{
double value = (double) joules;
return new Energy(value, EnergyUnit.Joule);
}
/// <summary>
/// Get Energy from KilobritishThermalUnits.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromKilobritishThermalUnits(double kilobritishthermalunits)
{
double value = (double) kilobritishthermalunits;
return new Energy(value, EnergyUnit.KilobritishThermalUnit);
}
/// <summary>
/// Get Energy from Kilocalories.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromKilocalories(double kilocalories)
{
double value = (double) kilocalories;
return new Energy(value, EnergyUnit.Kilocalorie);
}
/// <summary>
/// Get Energy from KiloelectronVolts.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromKiloelectronVolts(double kiloelectronvolts)
{
double value = (double) kiloelectronvolts;
return new Energy(value, EnergyUnit.KiloelectronVolt);
}
/// <summary>
/// Get Energy from Kilojoules.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromKilojoules(double kilojoules)
{
double value = (double) kilojoules;
return new Energy(value, EnergyUnit.Kilojoule);
}
/// <summary>
/// Get Energy from KilowattDays.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromKilowattDays(double kilowattdays)
{
double value = (double) kilowattdays;
return new Energy(value, EnergyUnit.KilowattDay);
}
/// <summary>
/// Get Energy from KilowattHours.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromKilowattHours(double kilowatthours)
{
double value = (double) kilowatthours;
return new Energy(value, EnergyUnit.KilowattHour);
}
/// <summary>
/// Get Energy from MegabritishThermalUnits.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromMegabritishThermalUnits(double megabritishthermalunits)
{
double value = (double) megabritishthermalunits;
return new Energy(value, EnergyUnit.MegabritishThermalUnit);
}
/// <summary>
/// Get Energy from Megacalories.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromMegacalories(double megacalories)
{
double value = (double) megacalories;
return new Energy(value, EnergyUnit.Megacalorie);
}
/// <summary>
/// Get Energy from MegaelectronVolts.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromMegaelectronVolts(double megaelectronvolts)
{
double value = (double) megaelectronvolts;
return new Energy(value, EnergyUnit.MegaelectronVolt);
}
/// <summary>
/// Get Energy from Megajoules.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromMegajoules(double megajoules)
{
double value = (double) megajoules;
return new Energy(value, EnergyUnit.Megajoule);
}
/// <summary>
/// Get Energy from MegawattDays.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromMegawattDays(double megawattdays)
{
double value = (double) megawattdays;
return new Energy(value, EnergyUnit.MegawattDay);
}
/// <summary>
/// Get Energy from MegawattHours.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromMegawattHours(double megawatthours)
{
double value = (double) megawatthours;
return new Energy(value, EnergyUnit.MegawattHour);
}
/// <summary>
/// Get Energy from Millijoules.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromMillijoules(double millijoules)
{
double value = (double) millijoules;
return new Energy(value, EnergyUnit.Millijoule);
}
/// <summary>
/// Get Energy from TeraelectronVolts.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromTeraelectronVolts(double teraelectronvolts)
{
double value = (double) teraelectronvolts;
return new Energy(value, EnergyUnit.TeraelectronVolt);
}
/// <summary>
/// Get Energy from TerawattDays.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromTerawattDays(double terawattdays)
{
double value = (double) terawattdays;
return new Energy(value, EnergyUnit.TerawattDay);
}
/// <summary>
/// Get Energy from TerawattHours.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromTerawattHours(double terawatthours)
{
double value = (double) terawatthours;
return new Energy(value, EnergyUnit.TerawattHour);
}
/// <summary>
/// Get Energy from ThermsEc.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromThermsEc(double thermsec)
{
double value = (double) thermsec;
return new Energy(value, EnergyUnit.ThermEc);
}
/// <summary>
/// Get Energy from ThermsImperial.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromThermsImperial(double thermsimperial)
{
double value = (double) thermsimperial;
return new Energy(value, EnergyUnit.ThermImperial);
}
/// <summary>
/// Get Energy from ThermsUs.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromThermsUs(double thermsus)
{
double value = (double) thermsus;
return new Energy(value, EnergyUnit.ThermUs);
}
/// <summary>
/// Get Energy from WattDays.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromWattDays(double wattdays)
{
double value = (double) wattdays;
return new Energy(value, EnergyUnit.WattDay);
}
/// <summary>
/// Get Energy from WattHours.
/// </summary>
/// <exception cref="ArgumentException">If value is NaN or Infinity.</exception>
[Windows.Foundation.Metadata.DefaultOverload]
public static Energy FromWattHours(double watthours)
{
double value = (double) watthours;
return new Energy(value, EnergyUnit.WattHour);
}
/// <summary>
/// Dynamically convert from value and unit enum <see cref="EnergyUnit" /> to <see cref="Energy" />.
/// </summary>
/// <param name="value">Value to convert from.</param>
/// <param name="fromUnit">Unit to convert from.</param>
/// <returns>Energy unit value.</returns>
// Fix name conflict with parameter "value"
[return: System.Runtime.InteropServices.WindowsRuntime.ReturnValueName("returnValue")]
public static Energy From(double value, EnergyUnit fromUnit)
{
return new Energy((double)value, fromUnit);
}
#endregion
#region Static Parse Methods
/// <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 Energy 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>
/// <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>
/// <param name="cultureName">Name of culture (ex: "en-US") to use when parsing number and unit. Defaults to <see cref="GlobalConfiguration.DefaultCulture" /> if null.</param>
public static Energy Parse(string str, [CanBeNull] string cultureName)
{
IFormatProvider provider = GetFormatProviderFromCultureName(cultureName);
return QuantityParser.Default.Parse<Energy, EnergyUnit>(
str,
provider,
From);
}
/// <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 Energy 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>
/// <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>
/// <param name="cultureName">Name of culture (ex: "en-US") to use when parsing number and unit. Defaults to <see cref="GlobalConfiguration.DefaultCulture" /> if null.</param>
public static bool TryParse([CanBeNull] string str, [CanBeNull] string cultureName, out Energy result)
{
IFormatProvider provider = GetFormatProviderFromCultureName(cultureName);
return QuantityParser.Default.TryParse<Energy, EnergyUnit>(
str,
provider,
From,
out result);
}
/// <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 EnergyUnit ParseUnit(string str)
{
return ParseUnit(str, null);
}
/// <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>
/// <param name="cultureName">Name of culture (ex: "en-US") to use when parsing number and unit. Defaults to <see cref="GlobalConfiguration.DefaultCulture" /> if null.</param>
public static EnergyUnit ParseUnit(string str, [CanBeNull] string cultureName)
{
IFormatProvider provider = GetFormatProviderFromCultureName(cultureName);
return UnitParser.Default.Parse<EnergyUnit>(str, provider);
}
public static bool TryParseUnit(string str, out EnergyUnit unit)
{
return TryParseUnit(str, null, out unit);
}
/// <summary>
/// Parse a unit string.
/// </summary>
/// <param name="str">String to parse. Typically in the form: {number} {unit}</param>
/// <param name="unit">The parsed unit if successful.</param>
/// <returns>True if successful, otherwise false.</returns>
/// <example>
/// Length.TryParseUnit("m", new CultureInfo("en-US"));
/// </example>
/// <param name="cultureName">Name of culture (ex: "en-US") to use when parsing number and unit. Defaults to <see cref="GlobalConfiguration.DefaultCulture" /> if null.</param>
public static bool TryParseUnit(string str, [CanBeNull] string cultureName, out EnergyUnit unit)
{
IFormatProvider provider = GetFormatProviderFromCultureName(cultureName);
return UnitParser.Default.TryParse<EnergyUnit>(str, provider, out unit);
}
#endregion
#region Equality / IComparable
public int CompareTo(object obj)
{
if(obj is null) throw new ArgumentNullException(nameof(obj));
if(!(obj is Energy objEnergy)) throw new ArgumentException("Expected type Energy.", nameof(obj));
return CompareTo(objEnergy);
}
// 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
internal int CompareTo(Energy other)
{
return _value.CompareTo(other.AsBaseNumericType(this.Unit));
}
[Windows.Foundation.Metadata.DefaultOverload]
public override bool Equals(object obj)
{
if(obj is null || !(obj is Energy objEnergy))
return false;
return Equals(objEnergy);
}
public bool Equals(Energy other)
{
return _value.Equals(other.AsBaseNumericType(this.Unit));
}
/// <summary>
/// <para>
/// Compare equality to another Energy 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(Energy 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>
/// Returns the hash code for this instance.
/// </summary>
/// <returns>A hash code for the current Energy.</returns>
public override int GetHashCode()
{
return new { QuantityType, Value, Unit }.GetHashCode();
}
#endregion
#region Conversion Methods
double IQuantity.As(object unit) => As((EnergyUnit)unit);
/// <summary>
/// Convert to the unit representation <paramref name="unit" />.
/// </summary>
/// <returns>Value converted to the specified unit.</returns>
public double As(EnergyUnit unit)
{
if(Unit == unit)
return Convert.ToDouble(Value);
var converted = AsBaseNumericType(unit);
return Convert.ToDouble(converted);
}
/// <summary>