Merge pull request #528 from tmilnthorp/Dimensionless

Dimensionless

Author: angularsen

UnitsNet.Tests/BaseDimensionsTests.cs

@@ -721,5 +721,24 @@ public void GetHashCodeWorksProperly()
             Assert.True(baseDimensions1.GetHashCode() != baseDimensions2.GetHashCode());
             Assert.True(baseDimensions1.GetHashCode() == baseDimensions3.GetHashCode());
         }
+
+        [Fact]
+        public void DimensionlessPropertyIsCorrect()
+        {
+            Assert.True(BaseDimensions.Dimensionless == new BaseDimensions(0, 0, 0, 0, 0, 0, 0));
+        }
+
+        [Fact]
+        public void IsDimensionlessMethodImplementedCorrectly()
+        {
+            Assert.True(BaseDimensions.Dimensionless.IsDimensionless());
+            Assert.True(new BaseDimensions(0, 0, 0, 0, 0, 0, 0).IsDimensionless());
+
+            Assert.False(BaseDimensions.Dimensionless.IsBaseQuantity());
+            Assert.False(BaseDimensions.Dimensionless.IsDerivedQuantity());
+
+            // Example case
+            Assert.True(Level.BaseDimensions.IsDimensionless());
+        }
     }
 }

UnitsNet.Tests/GeneratedCode/InformationTestsBase.g.cs

@@ -435,7 +435,7 @@ public void UnitsDoesNotContainUndefined()
         }
 
         [Fact]
-        public void AllUnitsHaveAtLeastOneAbbreviationSpecified()
+        public void HasAtLeastOneAbbreviationSpecified()
         {
             var units = Enum.GetValues(typeof(InformationUnit)).Cast<InformationUnit>();
             foreach(var unit in units)
@@ -446,5 +446,11 @@ public void AllUnitsHaveAtLeastOneAbbreviationSpecified()
                 var defaultAbbreviation = UnitAbbreviationsCache.Default.GetDefaultAbbreviation(unit);
             }
         }
+
+        [Fact]
+        public void BaseDimensionsShouldNeverBeNull()
+        {
+            Assert.False(Information.BaseDimensions is null);
+        }
     }
 }

UnitsNet.Tests/GeneratedCode/LengthTestsBase.g.cs

@@ -419,7 +419,7 @@ public void UnitsDoesNotContainUndefined()
         }
 
         [Fact]
-        public void AllUnitsHaveAtLeastOneAbbreviationSpecified()
+        public void HasAtLeastOneAbbreviationSpecified()
         {
             var units = Enum.GetValues(typeof(LengthUnit)).Cast<LengthUnit>();
             foreach(var unit in units)
@@ -430,5 +430,11 @@ public void AllUnitsHaveAtLeastOneAbbreviationSpecified()
                 var defaultAbbreviation = UnitAbbreviationsCache.Default.GetDefaultAbbreviation(unit);
             }
         }
+
+        [Fact]
+        public void BaseDimensionsShouldNeverBeNull()
+        {
+            Assert.False(Length.BaseDimensions is null);
+        }
     }
 }

UnitsNet.Tests/GeneratedCode/LevelTestsBase.g.cs

@@ -224,7 +224,7 @@ public void UnitsDoesNotContainUndefined()
         }
 
         [Fact]
-        public void AllUnitsHaveAtLeastOneAbbreviationSpecified()
+        public void HasAtLeastOneAbbreviationSpecified()
         {
             var units = Enum.GetValues(typeof(LevelUnit)).Cast<LevelUnit>();
             foreach(var unit in units)
@@ -235,5 +235,11 @@ public void AllUnitsHaveAtLeastOneAbbreviationSpecified()
                 var defaultAbbreviation = UnitAbbreviationsCache.Default.GetDefaultAbbreviation(unit);
             }
         }
+
+        [Fact]
+        public void BaseDimensionsShouldNeverBeNull()
+        {
+            Assert.False(Level.BaseDimensions is null);
+        }
     }
 }

UnitsNet.WindowsRuntimeComponent/GeneratedCode/Quantities/Information.WindowsRuntimeComponent.g.cs

@@ -66,7 +66,7 @@ public sealed partial class Information : IQuantity
 
         static Information()
         {
-            BaseDimensions = new BaseDimensions(0, 0, 0, 0, 0, 0, 0);
+            BaseDimensions = BaseDimensions.Dimensionless;
         }
         /// <summary>
         ///     Creates the quantity with a value of 0 in the base unit Bit.

UnitsNet.WindowsRuntimeComponent/GeneratedCode/Quantities/Level.WindowsRuntimeComponent.g.cs

@@ -66,7 +66,7 @@ public sealed partial class Level : IQuantity
 
         static Level()
         {
-            BaseDimensions = new BaseDimensions(0, 0, 0, 0, 0, 0, 0);
+            BaseDimensions = BaseDimensions.Dimensionless;
         }
         /// <summary>
         ///     Creates the quantity with a value of 0 in the base unit Decibel.

UnitsNet/BaseDimensions.cs

@@ -54,12 +54,21 @@ public bool IsBaseQuantity()
         }
 
         /// <summary>
-        /// Checks the dimensions represent a derived quantity.
+        /// Checks if the dimensions represent a derived quantity.
         /// </summary>
         /// <returns>True if the dimensions represent a derived quantity, otherwise false.</returns>
         public bool IsDerivedQuantity()
         {
-            return !IsBaseQuantity();
+            return !IsBaseQuantity() && !IsDimensionless();
+        }
+        
+        /// <summary>
+        /// Checks if this base dimensions object represents a dimensionless quantity.
+        /// </summary>
+        /// <returns>True if this object represents a dimensionless quantity, otherwise false.</returns>
+        public bool IsDimensionless()
+        {
+            return this == Dimensionless;
         }
 
         /// <inheritdoc />
@@ -246,5 +255,10 @@ private static void AppendDimensionString(StringBuilder sb, string name, int val
         /// Gets the luminous intensity dimensions (J).
         /// </summary>
         public int LuminousIntensity{ get; }
+
+        /// <summary>
+        /// Represents a dimensionless (unitless) quantity.
+        /// </summary>
+        public static BaseDimensions Dimensionless { get; } = new BaseDimensions(0, 0, 0, 0, 0, 0, 0);
     }
 }

UnitsNet/GeneratedCode/Quantities/Information.NetFramework.g.cs

@@ -63,7 +63,7 @@ public partial struct Information : IQuantity<InformationUnit>, IComparable, ICo
 
         static Information()
         {
-            BaseDimensions = new BaseDimensions(0, 0, 0, 0, 0, 0, 0);
+            BaseDimensions = BaseDimensions.Dimensionless;
         }
 
         /// <summary>

UnitsNet/GeneratedCode/Quantities/Level.NetFramework.g.cs

@@ -63,7 +63,7 @@ public partial struct Level : IQuantity<LevelUnit>, IComparable, IComparable<Lev
 
         static Level()
         {
-            BaseDimensions = new BaseDimensions(0, 0, 0, 0, 0, 0, 0);
+            BaseDimensions = BaseDimensions.Dimensionless;
         }
 
         /// <summary>

UnitsNet/Scripts/Include-GenerateQuantitySourceCodeNetFramework.ps1

@@ -19,7 +19,9 @@ function GenerateQuantitySourceCodeNetFramework([Quantity]$quantity, [string]$ta
     $unitEnumName = "$quantityName" + "Unit"
     $wrc = $target -eq "WindowsRuntimeComponent"
     $privateAccessModifierIfWrc = if ($wrc) { "private" } else { "public" }
+
     $baseDimensions = $quantity.BaseDimensions;
+    $isDimensionless = $baseDimensions -eq $null -or ( $baseDimensions.Length -eq 0 -and $baseDimensions.Mass -eq 0 -and $baseDimensions.Time -eq 0 -and $baseDimensions.ElectricCurrent -eq 0 -and $baseDimensions.Temperature -eq 0 -and $baseDimensions.AmountOfSubstance -eq 0 -and $baseDimensions.LuminousIntensity -eq 0 )
 
     [GeneratorArgs]$genArgs = New-Object GeneratorArgs -Property @{
       Quantity = $quantity;
@@ -112,10 +114,15 @@ if ($obsoleteAttribute)
 
         static $quantityName()
         {
-"@; if($baseDimensions)
+"@; if($isDimensionless)
+    {@"
+            BaseDimensions = BaseDimensions.Dimensionless;
+"@; }
+    else
     {@"
             BaseDimensions = new BaseDimensions($($baseDimensions.Length), $($baseDimensions.Mass), $($baseDimensions.Time), $($baseDimensions.ElectricCurrent), $($baseDimensions.Temperature), $($baseDimensions.AmountOfSubstance), $($baseDimensions.LuminousIntensity));
-"@; }@"
+"@; }
+@"
         }
 "@; # Windows Runtime Component requires a default constructor
     if ($wrc) {@"

UnitsNet/Scripts/Include-GenerateUnitTestBaseClassSourceCode.ps1

@@ -264,7 +264,7 @@ namespace UnitsNet.Tests
         }
 
         [Fact]
-        public void AllUnitsHaveAtLeastOneAbbreviationSpecified()
+        public void HasAtLeastOneAbbreviationSpecified()
         {
             var units = Enum.GetValues(typeof($unitEnumName)).Cast<$unitEnumName>();
             foreach(var unit in units)
@@ -275,6 +275,12 @@ namespace UnitsNet.Tests
                 var defaultAbbreviation = UnitAbbreviationsCache.Default.GetDefaultAbbreviation(unit);
             }
         }
+
+        [Fact]
+        public void BaseDimensionsShouldNeverBeNull()
+        {
+            Assert.False($quantityName.BaseDimensions is null);
+        }
     }
 }
 "@;