-
Notifications
You must be signed in to change notification settings - Fork 4
/
Area.cs
2005 lines (1894 loc) · 94.4 KB
/
Area.cs
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
using System;
using System.Globalization;
using System.Xml;
using System.Xml.Schema;
using System.Xml.Serialization;
#if !PocketPC || DesignTime
using System.ComponentModel;
#endif
namespace GeoFramework
{
/// <summary>
/// Represents the measurement of surface area of a polygon on Earth's
/// surface.
/// </summary>
/// <remarks>
/// <para>This structure is used to represent measurements of arbitrary polygons on
/// Earth's surface. Measurements can be converted to different unit types, such as
/// acres, square kilometers, and square miles.</para>
/// <para>Instances of this structure are guaranteed to be thread-safe because they are
/// immutable (properties can only be modified via constructors).</para>
/// </remarks>
/// <example>
/// This example demonstrates how to create an <strong>Area</strong> structure and
/// convert it to another unit type.
/// <code lang="VB">
/// ' Declare a Area of 50 meters
/// Dim Area1 As New Area(50, AreaUnit.SquareMeters)
/// ' Convert it into acres
/// Dim Area2 As Area = Area2.ToAcres()
/// </code>
/// <code lang="CS">
/// // Declare a Area of 50 meters
/// Area Area1 = new Area(50, AreaUnit.SquareMeters);
/// // Convert it into acres
/// Area Area2 = Area2.ToAcres();
/// </code>
/// </example>
#if !PocketPC || DesignTime
[TypeConverter("GeoFramework.Design.AreaConverter, GeoFramework.Design, Culture=neutral, Version=2.0.0.0, PublicKeyToken=d77afaeb30e3236a")]
#endif
public struct Area : IFormattable, IComparable<Area>, IEquatable<Area>, IXmlSerializable
{
private double _Value;
private AreaUnit _Units;
#region Constants
private const double AcresPerSquareMeter = 0.0002471054;
private const double AcresPerSquareCentimeter = 2.471054e-8;
private const double AcresPerSquareStatuteMile = 640;
private const double AcresPerSquareKilometer = 247.1054;
private const double AcresPerSquareInch = 1.594225e-7;
private const double AcresPerSquareNauticalMile = 847.547736;
private const double AcresPerSquareFoot = 2.29568411e-5;
private const double SquareFeetPerSquareMeter = 10.76391;
private const double SquareFeetPerSquareCentimeter = 0.001076391;
private const double SquareFeetPerSquareStatuteMile = 27878400;
private const double SquareFeetPerSquareKilometer = 10763910.4;
private const double SquareFeetPerSquareInch = 0.00694444444;
private const double SquareFeetPerSquareNauticalMile = 36919179.4;
private const double SquareFeetPerAcre = 43560;
private const double SquareInchesPerSquareMeter = 1550.003;
private const double SquareInchesPerSquareCentimeter = 0.1550003;
private const double SquareInchesPerSquareStatuteMile = 4014489600;
private const double SquareInchesPerSquareKilometer = 1.5500031e09;
private const double SquareInchesPerSquareFoot = 144;
private const double SquareInchesPerSquareNauticalMile = 5.31636183e9;
private const double SquareInchesPerAcre = 6272640;
private const double SquareStatuteMilesPerSquareMeter = 3.861022e-7;
private const double SquareStatuteMilesPerSquareCentimeter = 3.861022e-11;
private const double SquareStatuteMilesPerSquareKilometer = 0.3861022;
private const double SquareStatuteMilesPerSquareInch = 2.490977e-10;
private const double SquareStatuteMilesPerSquareFoot = 3.58700643e-8;
private const double SquareStatuteMilesPerSquareNauticalMile = 1.32429334 ;
private const double SquareStatuteMilesPerAcre = 0.0015625;
private const double SquareNauticalMilesPerSquareMeter = 2.9155335e-07;
private const double SquareNauticalMilesPerSquareCentimeter = 2.9155335e-11;
private const double SquareNauticalMilesPerSquareKilometer = 0.29155335;
private const double SquareNauticalMilesPerSquareInch = 1.88098559e-10;
private const double SquareNauticalMilesPerSquareFoot = 2.70861925e-8;
private const double SquareNauticalMilesPerSquareStatuteMile = 0.755119709;
private const double SquareNauticalMilesPerAcre = 0.00117987455;
private const double SquareCentimetersPerSquareStatuteMile = 2.58998811e10;
private const double SquareCentimetersPerSquareKilometer = 10000000000;
private const double SquareCentimetersPerSquareFoot = 929.0304;
private const double SquareCentimetersPerSquareInch = 6.4516;
private const double SquareCentimetersPerSquareMeter = 10000;
private const double SquareCentimetersPerSquareNauticalMile = 34299040000;
private const double SquareCentimetersPerAcre = 40468564.2;
private const double SquareMetersPerSquareStatuteMile = 2589988.11;
private const double SquareMetersPerSquareCentimeter = 0.0001;
private const double SquareMetersPerSquareKilometer = 1000000;
private const double SquareMetersPerSquareFoot = 0.09290304;
private const double SquareMetersPerSquareInch = 0.00064516;
private const double SquareMetersPerAcre = 4046.85642;
private const double SquareMetersPerSquareNauticalMile = 3429904;
private const double SquareKilometersPerSquareMeter = 0.000001;
private const double SquareKilometersPerSquareCentimeter = 1e-10;
private const double SquareKilometersPerSquareStatuteMile = 2.589988;
private const double SquareKilometersPerSquareFoot = 9.290304e-8;
private const double SquareKilometersPerSquareInch = 6.4516e-10;
private const double SquareKilometersPerSquareNauticalMile = 3.429904;
private const double SquareKilometersPerAcre = 0.004046856;
#endregion
#region Fields
/// <summary>Represents an area with no value.</summary>
public static readonly Area Empty = new Area(0.0, AreaUnit.SquareMeters).ToLocalUnitType();
/// <summary>Represents an area of infinite value.</summary>
/// <remarks>
/// In some rare cases, the result of a mathematical formula might be infinity. This
/// field is used to represent such values when they exist.
/// </remarks>
public static readonly Area Infinity = new Area(double.PositiveInfinity, AreaUnit.SquareMeters).ToLocalUnitType();
/// <summary>Represents the largest possible area which can be stored.</summary>
public static readonly Area Maximum = new Area(double.MaxValue, AreaUnit.SquareKilometers).ToLocalUnitType();
/// <summary>Represents the smallest possible area which can be stored.</summary>
public static readonly Area Minimum = new Area(double.MinValue, AreaUnit.SquareKilometers).ToLocalUnitType();
/// <summary>
/// Represents an invalid or unspecified area.
/// </summary>
public static readonly Area Invalid = new Area(double.NaN, AreaUnit.SquareMeters);
#endregion
#region Constructors
/// <summary>Creates a new instance using the specified value and unit type.</summary>
/// <example>
/// This example uses a constructor to create a new <strong>Area</strong> of fifty
/// square kilometers.
/// <code lang="VB">
/// Dim MyArea As New Area(50, AreaUnit.SquareKilometers)
/// </code>
/// <code lang="CS">
/// Area MyArea = new Area(50, AreaUnit.SquareKilometers);
/// </code>
/// </example>
public Area(double value, AreaUnit units)
{
_Value = value;
_Units = units;
}
/// <summary>Creates a new instance using the specified string.</summary>
/// <remarks>
/// This powerful constructor is used to convert an area measurement in the form of a
/// string into an object, such as one entered by a user or read from a file. This
/// constructor can accept any output created via the <see cref="ToString">ToString</see>
/// method.
/// </remarks>
/// <exception cref="ArgumentNullException" caption="ArgumentNullException">Parse method requires a valid Area measurement.</exception>
/// <exception cref="FormatException" caption="FormatException">1. The numeric portion of the Area measurement was not recognized.<br/>
/// 2. The Area unit type was not recognized or not specified.</exception>
/// <example>
/// This example demonstrates how the to use this constructor.
/// <code lang="VB">
/// Dim MyArea As Area
/// ' Create a Area of 50 square kilometers
/// MyArea = New Area("50 sq. km")
/// ' Create a Area of 14,387 miles, then convert it into square inches
/// MyArea = New Area("14,387 sq. statute miles").ToSquareInches()
/// ' Create a Area of 50 square feet
/// MyArea = New Area(" 50 sq ' ")
/// </code>
/// <code lang="CS">
/// Area MyArea;
/// ' Create a Area of 50 square kilometers
/// MyArea = new Area("50 sq. km");
/// ' Create a Area of 14,387 miles, then convert it into square inches
/// MyArea = new Area("14,387 sq. statute miles").ToSquareInches();
/// ' Create a Area of 50 square feet
/// MyArea = new Area(" 50 sq ' ");
/// </code>
/// </example>
/// <returns>An <strong>Area</strong> object.</returns>
/// <seealso cref="Parse(System.String)">Parse(string) Method</seealso>
public Area(string value)
: this(value, CultureInfo.CurrentCulture)
{}
/// <summary>Creates a new instance using the specified string and culture.</summary>
/// <remarks>
/// This powerful constructor is used to convert an area measurement in the form of a
/// string into an object, such as one entered by a user or read from a file. This
/// constructor can accept any output created via the <see cref="ToString">ToString</see>
/// method.
/// </remarks>
/// <exception cref="ArgumentNullException" caption="ArgumentNullException">Parse method requires a valid Area measurement.</exception>
/// <exception cref="FormatException" caption="FormatException">1. The numeric portion of the Area measurement was not recognized.<br/>
/// 2. The Area unit type was not recognized or not specified.</exception>
/// <example>
/// This example demonstrates how the to use this constructor.
/// <code lang="VB">
/// Dim MyArea As Area
/// ' Create a Area of 50 square kilometers
/// MyArea = New Area("50 sq. km", CultureInfo.CurrentCulture)
/// ' Create a Area of 14,387 miles, then convert it into square inches
/// MyArea = New Area("14,387 sq. statute miles", CultureInfo.CurrentCulture).ToSquareInches()
/// ' Create a Area of 50 square feet
/// MyArea = New Area(" 50 sq ' ", CultureInfo.CurrentCulture)
/// </code>
/// <code lang="CS">
/// Area MyArea;
/// ' Create a Area of 50 square kilometers
/// MyArea = new Area("50 sq. km", CultureInfo.CurrentCulture);
/// ' Create a Area of 14,387 miles, then convert it into square inches
/// MyArea = new Area("14,387 sq. statute miles", CultureInfo.CurrentCulture).ToSquareInches();
/// ' Create a Area of 50 square feet
/// MyArea = new Area(" 50 sq ' ", CultureInfo.CurrentCulture);
/// </code>
/// </example>
/// <returns>An <strong>Area</strong> object.</returns>
/// <seealso cref="Parse(System.String)">Parse(string) Method</seealso>
public Area(string value, CultureInfo culture)
{
// Anything to do?
if (value == null || value.Length == 0)
{
_Value = 0;
_Units = AreaUnit.SquareCentimeters;
return;
}
if (culture == null)
culture = CultureInfo.CurrentCulture;
string NumericPortion = null;
int Count = 0;
string Unit = null;
try
{
// Convert to uppercase and remove commas
value = value.Trim();
if (String.Compare(value, Properties.Resources.Common_Infinity, true, culture) == 0)
{
_Value = double.PositiveInfinity;
_Units = AreaUnit.SquareNauticalMiles;
return;
}
if (String.Compare(value, Properties.Resources.Common_Empty, true, culture) == 0)
{
_Value = 0;
_Units = AreaUnit.SquareCentimeters;
return;
}
// Clean up the value
value = value.ToUpper(culture).Replace(culture.NumberFormat.NumberGroupSeparator, "");
// Go until the first non-number character
Count = 0;
while (Count < value.Length)
{
string Digit = value.Substring(Count, 1);
if (Digit == "0" || Digit == "1" || Digit == "2" || Digit == "3"
|| Digit == "4" || Digit == "5" || Digit == "6" || Digit == "7"
|| Digit == "8" || Digit == "9"
|| Digit == culture.NumberFormat.NumberGroupSeparator
|| Digit == culture.NumberFormat.NumberDecimalSeparator)
// Allow continuation
Count = Count + 1;
else
// Non-numeric character!
break;
}
Unit = value.Substring(Count).Trim();
// Get the numeric portion
if (Count > 0)
NumericPortion = value.Substring(0, Count);
else
NumericPortion = "0";
#if PocketPC
try
{
_Value = double.Parse(NumericPortion, NumberStyles.Any, culture);
}
catch
{
throw new ArgumentException(Properties.Resources.Area_InvalidNumericPortion, "value");
}
#else
if(!double.TryParse(NumericPortion, NumberStyles.Any, culture, out _Value))
throw new ArgumentException(Properties.Resources.Area_InvalidNumericPortion, "value");
#endif
// Try to interpret the measurement
// Remove any notion of "square"
Unit = Unit.Replace("SQUARE", "S").Replace("SQ.", "S").Replace("SQ", "S").Replace(" ", "").Trim();
switch (Unit)
{
case "A":
case "AC":
case "ACRE":
case "ACRES":
_Units = AreaUnit.Acres;
break;
case "SCM":
case "SCM.":
case "SCENTIMETER":
case "SCENTIMETERS":
case "SCENTIMETRE":
case "SCENTIMETRES":
_Units = AreaUnit.SquareCentimeters;
break;
case "SM":
case "SM.":
case "SMETERS":
case "SMETRES":
case "SMETRE":
case "SMETER":
_Units = AreaUnit.SquareMeters;
break;
case "SKM":
case "SKM.":
case "SKILOMETRES":
case "SKILOMETERS":
case "SKILOMETRE":
case "SKILOMETER":
_Units = AreaUnit.SquareKilometers;
break;
case "SMI":
case "SMI.":
case "SMILE":
case "SMILES":
case "SSTATUTEMILES":
_Units = AreaUnit.SquareStatuteMiles;
break;
case "SNM":
case "SNM.":
case "SNAUTICALMILE":
case "SNAUTICALMILES":
_Units = AreaUnit.SquareNauticalMiles;
break;
case "SIN":
case "SIN.":
case "S\"":
case "SINCHES":
case "SINCH":
_Units = AreaUnit.SquareInches;
break;
case "SFT":
case "SFT.":
case "S'":
case "SFOOT":
case "SFEET":
_Units = AreaUnit.SquareFeet;
break;
default:
if (_Value == 0)
{
if (System.Globalization.RegionInfo.CurrentRegion.IsMetric)
_Units = AreaUnit.SquareMeters;
else
_Units = AreaUnit.SquareFeet;
}
else
{
throw new ArgumentException(Properties.Resources.Area_InvalidUnitPortion, "value");
}
break;
}
}
catch (Exception ex)
{
#if PocketPC
throw new ArgumentException(Properties.Resources.Area_InvalidFormat, ex);
#else
throw new ArgumentException(Properties.Resources.Area_InvalidFormat, "value", ex);
#endif
}
}
/// <summary>
/// Creates a new instance by deserializing the specified XML.
/// </summary>
/// <param name="reader"></param>
public Area(XmlReader reader)
{
// Initialize all fields
_Value = Double.NaN;
_Units = 0;
// Deserialize the object from XML
ReadXml(reader);
}
#endregion
#region Public Properties
/// <summary>Returns the units portion of an area measurement.</summary>
/// <value>An <strong>AreaUnit</strong> value. Default is <strong>Meters</strong>.</value>
/// <remarks>
/// <para>Each area measurement consists of a numeric value paired with a unit type
/// describing the value. It is not possible to create an area measurement without also
/// specifying a value.</para>
/// </remarks>
/// <seealso cref="Value">Value Property</seealso>
public AreaUnit Units
{
get
{
return _Units;
}
}
/// <summary>Returns the numeric portion of an area measurement.</summary>
/// <value>A <strong>Double</strong> value.</value>
/// <remarks>
/// This property is paired with the <strong>Units</strong> property to form a
/// complete area measurement.
/// </remarks>
/// <seealso cref="Units">Units Property</seealso>
public double Value
{
get
{
return _Value;
}
}
/// <summary>Indicates if the value of the current instance is zero.</summary>
/// <value>
/// A <strong>Boolean</strong>, <strong>True</strong> if the <strong>Value</strong>
/// property is zero.
/// </value>
public bool IsEmpty
{
get
{
return _Value == 0;
}
}
/// <summary>Indicates if the current instance is using a Metric unit.</summary>
/// <value>
/// A <strong>Boolean</strong>, <strong>True</strong> if the <strong>Units</strong>
/// property is <strong>SquareCentimeters</strong>, <strong>SquareMeters</strong> or
/// <strong>SquareKilometers</strong>.
/// </value>
/// <remarks>
/// This property is typically used to see if an area measurement is in a unit type
/// used by a specific culture. Area measurements can be adjusted to either Metric or
/// Imperial units using the <strong>ToMetricUnitType</strong> and
/// <strong>ToImperialUnitType</strong> methods.
/// </remarks>
public bool IsMetric
{
get
{
return _Units == AreaUnit.SquareCentimeters
|| _Units == AreaUnit.SquareMeters
|| _Units == AreaUnit.SquareKilometers;
}
}
/// <summary>Indicates if the current instance represents an infinite value.</summary>
/// <value>
/// A <strong>Boolean</strong>, <strong>True</strong> if the current instance
/// represents an infinite value.
/// </value>
public bool IsInfinity
{
get
{
return double.IsInfinity(_Value);
}
}
#endregion
#region Public Methods
/// <summary>Converts the current measurement into square feet.</summary>
/// <returns>A new <strong>Area</strong> object containing the converted
/// value.</returns>
/// <remarks>
/// This method will perform a conversion regardless of the current unit type. You
/// may convert from any unit type to any other unit type.
/// </remarks>
/// <seealso cref="ToSquareInches">ToSquareInches Method</seealso>
/// <seealso cref="ToSquareKilometers">ToSquareKilometers Method</seealso>
/// <seealso cref="ToSquareMeters">ToSquareMeters Method</seealso>
/// <seealso cref="ToSquareNauticalMiles">ToSquareNauticalMiles Method</seealso>
/// <seealso cref="ToSquareStatuteMiles">ToSquareStatuteMiles Method</seealso>
/// <example>
/// This example converts various three <strong>Area</strong> objects, each with a
/// different unit type, into square feet.
/// <code lang="VB">
/// ' Create Areas of different unit types
/// Dim Area1 As New Area(10, AreaUnit.SquareInches)
/// Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
/// Dim Area3 As New Area(50, AreaUnit.SquareKilometers)
/// ' Convert the Area measurements to square feet and output the result
/// Debug.WriteLine(Area1.ToSquareFeet().ToString())
/// Debug.WriteLine(Area2.ToSquareFeet().ToString())
/// Debug.WriteLine(Area3.ToSquareFeet().ToString())
/// </code>
/// <code lang="CS">
/// // Create Areas of different unit types
/// Area Area1 = new Area(10, AreaUnit.SquareInches);
/// Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
/// Area Area3 = new Area(50, AreaUnit.SquareKilometers);
/// // Convert the Area measurements to square feet and output the result
/// Console.WriteLine(Area1.ToSquareFeet().ToString());
/// Console.WriteLine(Area2.ToSquareFeet().ToString());
/// Console.WriteLine(Area3.ToSquareFeet().ToString());
/// </code>
/// </example>
public Area ToSquareFeet()
{
switch (_Units)
{
case AreaUnit.Acres:
return new Area(_Value * SquareFeetPerAcre, AreaUnit.SquareFeet);
case AreaUnit.SquareCentimeters:
return new Area(_Value * SquareFeetPerSquareCentimeter, AreaUnit.SquareFeet);
case AreaUnit.SquareMeters:
return new Area(_Value * SquareFeetPerSquareMeter, AreaUnit.SquareFeet);
case AreaUnit.SquareFeet:
return this;
case AreaUnit.SquareInches:
return new Area(_Value * SquareFeetPerSquareInch, AreaUnit.SquareFeet);
case AreaUnit.SquareKilometers:
return new Area(_Value * SquareFeetPerSquareKilometer, AreaUnit.SquareFeet);
case AreaUnit.SquareStatuteMiles:
return new Area(_Value * SquareFeetPerSquareStatuteMile, AreaUnit.SquareFeet);
case AreaUnit.SquareNauticalMiles:
return new Area(_Value * SquareFeetPerSquareNauticalMile, AreaUnit.SquareFeet);
default:
// This should never happen! Included only to satisfy the compiler
return Area.Empty;
}
}
/// <summary>Converts the current measurement into square inches.</summary>
/// <returns>A new <strong>Area</strong> object containing the converted
/// value.</returns>
/// <remarks>
/// This method will perform a conversion regardless of the current unit type. You
/// may convert from any unit type to any other unit type.
/// </remarks>
/// <example>
/// This example converts various three <strong>Area</strong> objects, each with a
/// different unit type, into square inches.
/// <code lang="VB">
/// ' Create Areas of different unit types
/// Dim Area1 As New Area(10, AreaUnit.SquareFeet)
/// Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
/// Dim Area3 As New Area(50, AreaUnit.SquareKilometers)
/// ' Convert the Area measurements to square inches and output the result
/// Debug.WriteLine(Area1.ToSquareInches().ToString())
/// Debug.WriteLine(Area2.ToSquareInches().ToString())
/// Debug.WriteLine(Area3.ToSquareInches().ToString())
/// </code>
/// <code lang="CS">
/// // Create Areas of different unit types
/// Area Area1 = new Area(10, AreaUnit.SquareFeet);
/// Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
/// Area Area3 = new Area(50, AreaUnit.SquareKilometers);
/// // Convert the Area measurements to square inches and output the result
/// Console.WriteLine(Area1.ToSquareInches().ToString());
/// Console.WriteLine(Area2.ToSquareInches().ToString());
/// Console.WriteLine(Area3.ToSquareInches().ToString());
/// </code>
/// </example>
/// <seealso cref="ToSquareFeet">ToSquareFeet Method</seealso>
/// <seealso cref="ToSquareKilometers">ToSquareKilometers Method</seealso>
/// <seealso cref="ToSquareMeters">ToSquareMeters Method</seealso>
/// <seealso cref="ToSquareNauticalMiles">ToSquareNauticalMiles Method</seealso>
/// <seealso cref="ToSquareStatuteMiles">ToSquareStatuteMiles Method</seealso>
public Area ToSquareInches()
{
switch (_Units)
{
case AreaUnit.Acres:
return new Area(_Value * SquareInchesPerAcre, AreaUnit.SquareInches);
case AreaUnit.SquareCentimeters:
return new Area(_Value * SquareInchesPerSquareCentimeter, AreaUnit.SquareInches);
case AreaUnit.SquareMeters:
return new Area(_Value * SquareInchesPerSquareMeter, AreaUnit.SquareInches);
case AreaUnit.SquareFeet:
return new Area(_Value * SquareInchesPerSquareFoot, AreaUnit.SquareInches);
case AreaUnit.SquareInches:
return this;
case AreaUnit.SquareKilometers:
return new Area(_Value * SquareInchesPerSquareKilometer, AreaUnit.SquareInches);
case AreaUnit.SquareStatuteMiles:
return new Area(_Value * SquareInchesPerSquareStatuteMile, AreaUnit.SquareInches);
case AreaUnit.SquareNauticalMiles:
return new Area(_Value * SquareInchesPerSquareNauticalMile, AreaUnit.SquareInches);
default:
// This should never happen! Included only to satisfy the compiler
return Area.Empty;
}
}
/// <returns>A new <strong>Area</strong> object containing the converted
/// value.</returns>
/// <remarks>
/// This method will perform a conversion regardless of the current unit type. You
/// may convert from any unit type to any other unit type.
/// </remarks>
/// <summary>Converts the current measurement into square kilometers.</summary>
/// <example>
/// This example converts various three <strong>Area</strong> objects, each with a
/// different unit type, into square kilometers.
/// <code lang="VB">
/// ' Create Areas of different unit types
/// Dim Area1 As New Area(10, AreaUnit.SquareFeet)
/// Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
/// Dim Area3 As New Area(50, AreaUnit.SquareInches)
/// ' Convert the Area measurements to square kilometers and output the result
/// Debug.WriteLine(Area1.ToSquareKilometers().ToString())
/// Debug.WriteLine(Area2.ToSquareKilometers().ToString())
/// Debug.WriteLine(Area3.ToSquareKilometers().ToString())
/// </code>
/// <code lang="CS">
/// // Create Areas of different unit types
/// Area Area1 = new Area(10, AreaUnit.SquareFeet);
/// Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
/// Area Area3 = new Area(50, AreaUnit.SquareInches);
/// // Convert the Area measurements to square kilometers and output the result
/// Console.WriteLine(Area1.ToSquareKilometers().ToString());
/// Console.WriteLine(Area2.ToSquareKilometers().ToString());
/// Console.WriteLine(Area3.ToSquareKilometers().ToString());
/// </code>
/// </example>
/// <seealso cref="ToSquareFeet">ToSquareFeet Method</seealso>
/// <seealso cref="ToSquareInches">ToSquareInches Method</seealso>
/// <seealso cref="ToSquareMeters">ToSquareMeters Method</seealso>
/// <seealso cref="ToSquareNauticalMiles">ToSquareNauticalMiles Method</seealso>
/// <seealso cref="ToSquareStatuteMiles">ToSquareStatuteMiles Method</seealso>
public Area ToSquareKilometers()
{
switch (_Units)
{
case AreaUnit.Acres:
return new Area(_Value * SquareKilometersPerAcre, AreaUnit.SquareKilometers);
case AreaUnit.SquareCentimeters:
return new Area(_Value * SquareKilometersPerSquareCentimeter, AreaUnit.SquareKilometers);
case AreaUnit.SquareMeters:
return new Area(_Value * SquareKilometersPerSquareMeter, AreaUnit.SquareKilometers);
case AreaUnit.SquareFeet:
return new Area(_Value * SquareKilometersPerSquareFoot, AreaUnit.SquareKilometers);
case AreaUnit.SquareInches:
return new Area(_Value * SquareKilometersPerSquareInch, AreaUnit.SquareKilometers);
case AreaUnit.SquareKilometers:
return this;
case AreaUnit.SquareStatuteMiles:
return new Area(_Value * SquareKilometersPerSquareStatuteMile, AreaUnit.SquareKilometers);
case AreaUnit.SquareNauticalMiles:
return new Area(_Value * SquareKilometersPerSquareNauticalMile, AreaUnit.SquareKilometers);
default:
// This should never happen! Included only to satisfy the compiler
return Area.Empty;
}
}
/// <returns>A new <strong>Area</strong> object containing the converted
/// value.</returns>
/// <remarks>
/// This method will perform a conversion regardless of the current unit type. You
/// may convert from any unit type to any other unit type.
/// </remarks>
/// <summary>Converts the current measurement into square meters.</summary>
/// <example>
/// This example converts various three <strong>Area</strong> objects, each with a
/// different unit type, into square meters.
/// <code lang="VB">
/// ' Create Areas of different unit types
/// Dim Area1 As New Area(10, AreaUnit.SquareFeet)
/// Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
/// Dim Area3 As New Area(50, AreaUnit.SquareInches)
/// ' Convert the Area measurements to square meters and output the result
/// Debug.WriteLine(Area1.ToSquareMeters().ToString())
/// Debug.WriteLine(Area2.ToSquareMeters().ToString())
/// Debug.WriteLine(Area3.ToSquareMeters().ToString())
/// </code>
/// <code lang="CS">
/// // Create Areas of different unit types
/// Area Area1 = new Area(10, AreaUnit.SquareFeet);
/// Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
/// Area Area3 = new Area(50, AreaUnit.SquareInches);
/// // Convert the Area measurements to square meters and output the result
/// Console.WriteLine(Area1.ToSquareMeters().ToString());
/// Console.WriteLine(Area2.ToSquareMeters().ToString());
/// Console.WriteLine(Area3.ToSquareMeters().ToString());
/// </code>
/// </example>
/// <seealso cref="ToSquareFeet">ToSquareFeet Method</seealso>
/// <seealso cref="ToSquareInches">ToSquareInches Method</seealso>
/// <seealso cref="ToSquareKilometers">ToSquareKilometers Method</seealso>
/// <seealso cref="ToSquareNauticalMiles">ToSquareNauticalMiles Method</seealso>
/// <seealso cref="ToSquareStatuteMiles">ToSquareStatuteMiles Method</seealso>
public Area ToSquareMeters()
{
switch (_Units)
{
case AreaUnit.Acres:
return new Area(_Value * SquareMetersPerAcre, AreaUnit.SquareMeters);
case AreaUnit.SquareCentimeters:
return new Area(_Value * SquareMetersPerSquareCentimeter, AreaUnit.SquareMeters);
case AreaUnit.SquareMeters:
return this;
case AreaUnit.SquareFeet:
return new Area(_Value * SquareMetersPerSquareFoot, AreaUnit.SquareMeters);
case AreaUnit.SquareInches:
return new Area(_Value * SquareMetersPerSquareInch, AreaUnit.SquareMeters);
case AreaUnit.SquareKilometers:
return new Area(_Value * SquareMetersPerSquareKilometer, AreaUnit.SquareMeters);
case AreaUnit.SquareStatuteMiles:
return new Area(_Value * SquareMetersPerSquareStatuteMile, AreaUnit.SquareMeters);
case AreaUnit.SquareNauticalMiles:
return new Area(_Value * SquareMetersPerSquareNauticalMile, AreaUnit.SquareMeters);
default:
// This should never happen! Included only to satisfy the compiler
return Area.Empty;
}
}
/// <returns>A new <strong>Area</strong> object containing the converted
/// value.</returns>
/// <remarks>
/// This method will perform a conversion regardless of the current unit type. You
/// may convert from any unit type to any other unit type.
/// </remarks>
/// <summary>Converts the current measurement into square nautical miles.</summary>
/// <example>
/// This example converts various three <strong>Area</strong> objects, each with a
/// different unit type, into square nautical miles.
/// <code lang="VB">
/// ' Create Areas of different unit types
/// Dim Area1 As New Area(10, AreaUnit.SquareFeet)
/// Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
/// Dim Area3 As New Area(50, AreaUnit.SquareInches)
/// ' Convert the Area measurements to square nautical miles and output the result
/// Debug.WriteLine(Area1.ToSquareNauticalMiles().ToString())
/// Debug.WriteLine(Area2.ToSquareNauticalMiles().ToString())
/// Debug.WriteLine(Area3.ToSquareNauticalMiles().ToString())
/// </code>
/// <code lang="CS">
/// // Create Areas of different unit types
/// Area Area1 = new Area(10, AreaUnit.SquareFeet);
/// Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
/// Area Area3 = new Area(50, AreaUnit.SquareInches);
/// // Convert the Area measurements to square nautical miles and output the result
/// Console.WriteLine(Area1.ToSquareNauticalMiles().ToString());
/// Console.WriteLine(Area2.ToSquareNauticalMiles().ToString());
/// Console.WriteLine(Area3.ToSquareNauticalMiles().ToString());
/// </code>
/// </example>
/// <seealso cref="ToSquareFeet">ToSquareFeet Method</seealso>
/// <seealso cref="ToSquareInches">ToSquareInches Method</seealso>
/// <seealso cref="ToSquareKilometers">ToSquareKilometers Method</seealso>
/// <seealso cref="ToSquareMeters">ToSquareMeters Method</seealso>
/// <seealso cref="ToSquareStatuteMiles">ToSquareStatuteMiles Method</seealso>
public Area ToSquareNauticalMiles()
{
switch (_Units)
{
case AreaUnit.Acres:
return new Area(_Value * SquareNauticalMilesPerAcre, AreaUnit.SquareNauticalMiles);
case AreaUnit.SquareCentimeters:
return new Area(_Value * SquareNauticalMilesPerSquareCentimeter, AreaUnit.SquareNauticalMiles);
case AreaUnit.SquareMeters:
return new Area(_Value * SquareNauticalMilesPerSquareMeter, AreaUnit.SquareNauticalMiles);
case AreaUnit.SquareFeet:
return new Area(_Value * SquareNauticalMilesPerSquareFoot, AreaUnit.SquareNauticalMiles);
case AreaUnit.SquareInches:
return new Area(_Value * SquareNauticalMilesPerSquareInch, AreaUnit.SquareNauticalMiles);
case AreaUnit.SquareKilometers:
return new Area(_Value * SquareNauticalMilesPerSquareKilometer, AreaUnit.SquareNauticalMiles);
case AreaUnit.SquareStatuteMiles:
return new Area(_Value * SquareNauticalMilesPerSquareStatuteMile, AreaUnit.SquareNauticalMiles);
case AreaUnit.SquareNauticalMiles:
return this;
default:
// This should never happen! Included only to satisfy the compiler
return Area.Empty;
}
}
/// <returns>A new <strong>Area</strong> object containing the converted
/// value.</returns>
/// <remarks>
/// This method will perform a conversion regardless of the current unit type. A
/// "statute mile" is frequently referred to as "mile" by itself.
/// </remarks>
/// <summary>Converts the current measurement into square miles.</summary>
/// <example>
/// This example converts various three <strong>Area</strong> objects, each with a
/// different unit type, into square miles.
/// <code lang="VB">
/// ' Create Areas of different unit types
/// Dim Area1 As New Area(10, AreaUnit.SquareFeet)
/// Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
/// Dim Area3 As New Area(50, AreaUnit.SquareInches)
/// ' Convert the Area measurements to square statute miles and output the result
/// Debug.WriteLine(Area1.ToSquareStatuteMiles().ToString())
/// Debug.WriteLine(Area2.ToSquareStatuteMiles().ToString())
/// Debug.WriteLine(Area3.ToSquareStatuteMiles().ToString())
/// </code>
/// <code lang="CS">
/// // Create Areas of different unit types
/// Area Area1 = new Area(10, AreaUnit.SquareFeet);
/// Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
/// Area Area3 = new Area(50, AreaUnit.SquareInches);
/// // Convert the Area measurements to square statute miles and output the result
/// Console.WriteLine(Area1.ToSquareStatuteMiles().ToString());
/// Console.WriteLine(Area2.ToSquareStatuteMiles().ToString());
/// Console.WriteLine(Area3.ToSquareStatuteMiles().ToString());
/// </code>
/// </example>
/// <seealso cref="ToSquareFeet">ToSquareFeet Method</seealso>
/// <seealso cref="ToSquareInches">ToSquareInches Method</seealso>
/// <seealso cref="ToSquareKilometers">ToSquareKilometers Method</seealso>
/// <seealso cref="ToSquareMeters">ToSquareMeters Method</seealso>
/// <seealso cref="ToSquareNauticalMiles">ToSquareNauticalMiles Method</seealso>
public Area ToSquareStatuteMiles()
{
switch (_Units)
{
case AreaUnit.Acres:
return new Area(_Value * SquareStatuteMilesPerAcre, AreaUnit.SquareStatuteMiles);
case AreaUnit.SquareCentimeters:
return new Area(_Value * SquareStatuteMilesPerSquareCentimeter, AreaUnit.SquareStatuteMiles);
case AreaUnit.SquareMeters:
return new Area(_Value * SquareStatuteMilesPerSquareMeter, AreaUnit.SquareStatuteMiles);
case AreaUnit.SquareFeet:
return new Area(_Value * SquareStatuteMilesPerSquareFoot, AreaUnit.SquareStatuteMiles);
case AreaUnit.SquareInches:
return new Area(_Value * SquareStatuteMilesPerSquareInch, AreaUnit.SquareStatuteMiles);
case AreaUnit.SquareKilometers:
return new Area(_Value * SquareStatuteMilesPerSquareKilometer, AreaUnit.SquareStatuteMiles);
case AreaUnit.SquareStatuteMiles:
return this;
case AreaUnit.SquareNauticalMiles:
return new Area(_Value * SquareStatuteMilesPerSquareNauticalMile, AreaUnit.SquareStatuteMiles);
default:
// This should never happen! Included only to satisfy the compiler
return Area.Empty;
}
}
/// <summary>Converts the current measurement into acres.</summary>
/// <example>
/// This example converts various three <strong>Area</strong> objects, each with a
/// different unit type, into acres.
/// <code lang="VB" title="[New Example]">
/// ' Create Areas of different unit types
/// Dim Area1 As New Area(10, AreaUnit.SquareFeet)
/// Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
/// Dim Area3 As New Area(50, AreaUnit.SquareInches)
/// ' Convert the Area measurements to acres and output the result
/// Debug.WriteLine(Area1.ToAcres().ToString())
/// Debug.WriteLine(Area2.ToAcres().ToString())
/// Debug.WriteLine(Area3.ToAcres().ToString())
/// </code>
/// <code lang="CS" title="[New Example]">
/// // Create Areas of different unit types
/// Area Area1 = new Area(10, AreaUnit.SquareFeet);
/// Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
/// Area Area3 = new Area(50, AreaUnit.SquareInches);
/// // Convert the Area measurements to acres and output the result
/// Console.WriteLine(Area1.ToAcres().ToString());
/// Console.WriteLine(Area2.ToAcres().ToString());
/// Console.WriteLine(Area3.ToAcres().ToString());
/// </code>
/// </example>
/// <returns>A new <strong>Area</strong> object containing the converted value.</returns>
/// <remarks>This method will perform a conversion regardless of the current unit type.</remarks>
public Area ToAcres()
{
switch (_Units)
{
case AreaUnit.Acres:
return this;
case AreaUnit.SquareCentimeters:
return new Area(_Value * AcresPerSquareCentimeter, AreaUnit.Acres);
case AreaUnit.SquareMeters:
return new Area(_Value * AcresPerSquareMeter, AreaUnit.Acres);
case AreaUnit.SquareFeet:
return new Area(_Value * AcresPerSquareFoot, AreaUnit.Acres);
case AreaUnit.SquareInches:
return new Area(_Value * AcresPerSquareInch, AreaUnit.Acres);
case AreaUnit.SquareKilometers:
return new Area(_Value * AcresPerSquareKilometer, AreaUnit.Acres);
case AreaUnit.SquareStatuteMiles:
return new Area(_Value * AcresPerSquareStatuteMile, AreaUnit.Acres);
case AreaUnit.SquareNauticalMiles:
return new Area(_Value * AcresPerSquareNauticalMile, AreaUnit.Acres);
default:
// This should never happen! Included only to satisfy the compiler
return Area.Empty;
}
}
/// <summary>Converts the current measurement into square centimeters.</summary>
/// <example>
/// This example converts various three <strong>Area</strong> objects, each with a
/// different unit type, into square centimeters.
/// <code lang="VB" title="[New Example]">
/// ' Create Areas of different unit types
/// Dim Area1 As New Area(10, AreaUnit.SquareFeet)
/// Dim Area2 As New Area(20, AreaUnit.SquareStatuteMiles)
/// Dim Area3 As New Area(50, AreaUnit.SquareInches)
/// ' Convert the Area measurements to square centimeters and output the result
/// Debug.WriteLine(Area1.ToSquareCentimeters().ToString())
/// Debug.WriteLine(Area2.ToSquareCentimeters().ToString())
/// Debug.WriteLine(Area3.ToSquareCentimeters().ToString())
/// </code>
/// <code lang="CS" title="[New Example]">
/// // Create Areas of different unit types
/// Area Area1 = new Area(10, AreaUnit.SquareFeet);
/// Area Area2 = new Area(20, AreaUnit.SquareStatuteMiles);
/// Area Area3 = new Area(50, AreaUnit.SquareInches);
/// // Convert the Area measurements to square centimeters and output the result
/// Console.WriteLine(Area1.ToSquareCentimeters().ToString());
/// Console.WriteLine(Area2.ToSquareCentimeters().ToString());
/// Console.WriteLine(Area3.ToSquareCentimeters().ToString());
/// </code>
/// </example>
/// <returns>A new <strong>Area</strong> object containing the converted value.</returns>
/// <remarks>This method will perform a conversion regardless of the current unit type.</remarks>
public Area ToSquareCentimeters()
{
switch (_Units)
{
case AreaUnit.Acres:
return new Area(_Value * SquareCentimetersPerAcre, AreaUnit.Acres);
case AreaUnit.SquareCentimeters:
return this;
case AreaUnit.SquareMeters:
return new Area(_Value * SquareCentimetersPerSquareMeter, AreaUnit.Acres);
case AreaUnit.SquareFeet:
return new Area(_Value * SquareCentimetersPerSquareFoot, AreaUnit.Acres);
case AreaUnit.SquareInches:
return new Area(_Value * SquareCentimetersPerSquareInch, AreaUnit.Acres);
case AreaUnit.SquareKilometers:
return new Area(_Value * SquareCentimetersPerSquareKilometer, AreaUnit.Acres);
case AreaUnit.SquareStatuteMiles:
return new Area(_Value * SquareCentimetersPerSquareStatuteMile, AreaUnit.Acres);
case AreaUnit.SquareNauticalMiles:
return new Area(_Value * SquareCentimetersPerSquareNauticalMile, AreaUnit.Acres);
default:
// This should never happen! Included only to satisfy the compiler
return Area.Empty;
}
}
/// <summary>
/// Converts the current instance to an Imperial unit type which minimizes numeric
/// value.
/// </summary>
/// <returns>
/// An <strong>Area</strong> converted to Imperial units. (i.e. feet, inches,
/// miles)
/// </returns>
/// <remarks>
/// <para>This method is used to make an area measurement easier to read by choosing
/// another unit type. For example, "27,878,400 square feet" would be easier to
/// understand as "1 square statute mile." This method converts the current instance to
/// Metric unit which brings the <strong>Value</strong> closest to 1, then returns the
/// new value. This method will perform a conversion regardless of the current unit
/// type.</para>
/// </remarks>
/// <example>
/// This example converts a measurement of 10560 feet into 1 square statute mile using
/// the <strong>ToMetricUnitType</strong> method.
/// <code lang="VB" title="[New Example]">
/// Dim Area1 As New Area(27878400, AreaUnit.SquareFeet)
/// Dim Area2 As Area = Area1.ToImperialUnitType()
/// Debug.WriteLine(Area2.ToString())
/// ' Output: 1 square statute mile
/// </code>
/// <code lang="CS" title="[New Example]">
/// Area Area1 = new Area(27878400, AreaUnit.SquareFeet);
/// Area Area2 = Area1.ToImperialUnitType();
/// Console.WriteLine(Area2.ToString());
/// // Output: 1 square statute mile
/// </code>
/// </example>
public Area ToImperialUnitType()
{
// Start with the largest possible unit
Area Temp = ToSquareStatuteMiles();
// If the value is less than one, bump down
if (Math.Abs(Temp.Value) < 1.0)
Temp = Temp.ToSquareFeet();
if (Math.Abs(Temp.Value) < 1.0)