downgrade to .NET 4.0

add docs

Author: gena

Diff for: build.proj

@@ -5,7 +5,7 @@
     <SolutionDir>$(MSBuildProjectDirectory)</SolutionDir> 
     <ProjectsToBuild>src\BasicModelInterface\BasicModelInterface.csproj;src\BasicModelInterfaceRunner\BasicModelInterfaceRunner.csproj</ProjectsToBuild>
     <NuGetCmd>$(BuildPath)\tools\NuGet</NuGetCmd>
-    <ProgramVersion>1.0.0.5</ProgramVersion>
+    <ProgramVersion>1.0.0.10</ProgramVersion>
   </PropertyGroup>
 
   <Target Name="Clean">

Diff for: src/BasicModelInterface.Tests/BasicModelInterface.Tests.csproj

@@ -9,8 +9,9 @@
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <RootNamespace>BasicModelInterface.Tests</RootNamespace>
     <AssemblyName>BasicModelInterface.Tests</AssemblyName>
-    <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
+    <TargetFrameworkVersion>v4.0</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
+    <TargetFrameworkProfile />
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>

Diff for: src/BasicModelInterface.Tests/BasicModelInterfaceLibraryTest.cs

@@ -96,6 +96,10 @@ public void GetValues_2D_Int()
 
             var valuesExpected = new[,] { { 3, 2, 1 }, { 6, 4, 2 } };
 
+
+            var v = 5.0;
+            library.SetValue("a", v);
+
             Assert.AreEqual(valuesExpected, values);
         }
 
@@ -114,6 +118,7 @@ public void SetValues_2D_Int()
         {
             var values = new[,] { { 1, 2, 3 }, { 4, 5, 6 } };
 
+            library.SetValues(library.VariableNames[1], values);
             library.SetValues(library.VariableNames[1], values);
 
             Assert.AreEqual(values, library.GetValues(library.VariableNames[1]));

Diff for: src/BasicModelInterface/BasicModelInterface.csproj

@@ -9,8 +9,9 @@
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <RootNamespace>BasicModelInterface</RootNamespace>
     <AssemblyName>BasicModelInterface</AssemblyName>
-    <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
+    <TargetFrameworkVersion>v4.0</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
+    <TargetFrameworkProfile />
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
@@ -30,6 +31,12 @@
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
   </PropertyGroup>
+  <PropertyGroup>
+    <SignAssembly>true</SignAssembly>
+  </PropertyGroup>
+  <PropertyGroup>
+    <AssemblyOriginatorKeyFile>BasicModelInterface.snk</AssemblyOriginatorKeyFile>
+  </PropertyGroup>
   <ItemGroup>
     <Reference Include="System" />
     <Reference Include="System.Core" />
@@ -40,13 +47,17 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="BasicModelInterfaceExtensions.cs" />
     <Compile Include="BasicModelInterfaceLibrary.cs" />
     <Compile Include="Interop\DynamicDllImport.cs" />
     <Compile Include="Interop\DynamicDllImportMetaObject.cs" />
     <Compile Include="IBasicModelInterface.cs" />
     <Compile Include="Logger.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
+  <ItemGroup>
+    <None Include="BasicModelInterface.snk" />
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.

Diff for: src/BasicModelInterface/BasicModelInterface.nuspec

@@ -11,10 +11,11 @@
     <language>en-US</language>
     <projectUrl>https://github.com/openearth/bmi-csharp</projectUrl>
     <licenseUrl>http://www.gnu.org/licenses/lgpl.html</licenseUrl>
-    <releaseNotes>... a list of changes in this release ...</releaseNotes>
+    <releaseNotes>... list of changes in this release ...</releaseNotes>
   </metadata>
   <files>
-    <file src="bin\Debug\BasicModelInterface.dll " target="lib\net45\BasicModelInterface.dll" />
-    <file src="..\..\target\bmi-runner.exe " target="tools\net45\bmi-runner.exe" />
+    <file src="bin\Debug\BasicModelInterface.dll" target="lib\net40\BasicModelInterface.dll" />
+    <file src="bin\Debug\BasicModelInterface.pdb" target="lib\net40\BasicModelInterface.pdb" />
+    <file src="..\..\target\bmi-runner.exe " target="tools\net40\bmi-runner.exe" />
   </files>
 </package>

Diff for: src/BasicModelInterface/BasicModelInterfaceLibrary.cs

@@ -17,7 +17,7 @@ public class BasicModelInterfaceLibrary : IBasicModelInterface
 
         private const int MAXSTRLEN = 1024;
 
-        private readonly dynamic lib;
+        private dynamic lib;
 
         private string originalCurrentDirectory;
 
@@ -126,14 +126,15 @@ public int Finish()
             return lib.finalize();
         }
 
-        public T GetValue<T>(string variable)
+        public int[] GetShape(string variable)
         {
-            throw new NotImplementedException("implement using set_var, array with a single value");
-        }
+            var rank = 0;
+            lib.get_var_rank(variable, ref rank);
 
-        public void SetValue<T>(string variable, T value)
-        {
-            throw new NotImplementedException("implement using get_var, array with a single value");
+            var shape = new int[MAXDIMS];
+            lib.get_var_shape(variable, shape);
+
+            return shape.Take(rank).ToArray();
         }
 
         public string[] VariableNames
@@ -154,9 +155,14 @@ public Array GetValues(string variable)
             Trace.Assert(!string.IsNullOrEmpty(variable));
 
             // get values (pointer)
-            IntPtr ptr = IntPtr.Zero;
+            var ptr = IntPtr.Zero;
             lib.get_var(variable, ref ptr);
 
+            if (ptr == IntPtr.Zero)
+            {
+                return null;
+            }
+
             // get rank
             int rank = 0;
             lib.get_var_rank(variable, ref rank);
@@ -169,52 +175,34 @@ public Array GetValues(string variable)
             // get value type
             var typeNameBuilder = new StringBuilder(MAXSTRLEN);
             lib.get_var_type(variable, typeNameBuilder);
-            string typeName = typeNameBuilder.ToString();
+            var typeName = typeNameBuilder.ToString();
 
             // copy to 1D array
             var totalLength = GetTotalLength(shape);
+
             var values1D = ToArray1D(ptr, typeName, totalLength);
 
             if (rank == 1)
             {
                 return values1D;
             }
 
-            // convert to nD array (unfotrunately can't copy to nD array at once :()
-            var values = Array.CreateInstance(ToType(typeName), shape);
-
-            var index = new int[rank];
-            var dim = rank - 1;
-            var reset = false;
-            for (var i = 0; i < totalLength; i++)
-            {
-                // increment the lowest dimension
-                while (index[dim] == shape[dim])
-                {
-                    for (var j = dim; j < rank; j++)
-                    {
-                        index[j] = 0;
-                    }
-
-                    dim--;
-                    index[dim]++;
-                    reset = true;
-                }
-
-
-                // reset to the last dimension
-                if (reset)
-                {
-                    dim = rank - 1;
-                    reset = false;
-                }
+            // convert to nD array
+            var valueType = ToType(typeName);
+            var values = Array.CreateInstance(valueType, shape);
+            Buffer.BlockCopy(values1D, 0, values, 0, values1D.Length * Marshal.SizeOf(valueType));
 
-                values.SetValue(values1D.GetValue(i), index);
+            return values;
+        }
 
-                index[dim]++;
-            }
+        public Array GetValues(string variable, int[] index)
+        {
+            throw new NotImplementedException();
+        }
 
-            return values;
+        public Array GetValues(string variable, int[] start, int[] count)
+        {
+            throw new NotImplementedException();
         }
 
         public void SetValues(string variable, Array values)
@@ -265,6 +253,11 @@ public void SetValues(string variable, int[] start, int[] count, Array values)
             }
         }
 
+        public void SetValues(string variable, int[] index, Array values)
+        {
+            throw new NotImplementedException();
+        }
+
         /// <summary>
         ///     Run model in one step from start to end.
         /// </summary>
@@ -276,10 +269,9 @@ public static void Run(string library, string configPath)
             {
                 Logger = (level, message) => Console.WriteLine("{0}: {1}", level, message)
             };
-
             model.Initialize(configPath);
 
-            int sameTimeCounter = 0;
+            var sameTimeCounter = 0;
 
             DateTime t = model.StartTime;
             while (t < model.StopTime)
@@ -357,7 +349,7 @@ private Array ToArray1D(IntPtr ptr, string valueType, int totalLength)
             throw new NotSupportedException("Unsupported type: " + valueType);
         }
 
-        private static int GetTotalLength(int[] shape)
+        internal static int GetTotalLength(int[] shape)
         {
             return shape.Aggregate(1, (current, t) => current * t);
         }

Diff for: src/BasicModelInterface/IBasicModelInterface.cs

@@ -16,24 +16,89 @@ public interface IBasicModelInterface
 
         TimeSpan TimeStep { get; }
 
+        /// <summary>
+        /// Gets names of all available variables.
+        /// </summary>
         string[] VariableNames { get; }
 
+        /// <summary>
+        /// Injects logger into the model so that it can log messages. A callback method.
+        /// </summary>
+        Logger Logger { get; set; }
+
+        /// <summary>
+        /// Initializes model using a given configuration file..
+        /// </summary>
+        /// <param name="path"></param>
+        /// <returns></returns>
         int Initialize(string path);
 
-        int Update(double dt);
+        /// <summary>
+        /// Performs simulation.
+        /// </summary>
+        /// <param name="dt">When default value -1 is used - model computes time step automatically.</param>
+        /// <returns></returns>
+        int Update(double dt = -1);
 
+        /// <summary>
+        /// Finishes model. Deallocates all arrays, closes all handles, frees all other used resources.
+        /// </summary>
+        /// <returns></returns>
         int Finish();
 
-        T GetValue<T>(string variable);
-
-        void SetValue<T>(string variable, T value);
+        /// <summary>
+        /// Gets shape of the variable (sizes of all dimensions).
+        /// </summary>
+        /// <param name="variable"></param>
+        /// <returns></returns>
+        int[] GetShape(string variable);
 
+        /// <summary>
+        /// Gets variable values.
+        /// </summary>
+        /// <param name="variable"></param>
+        /// <returns></returns>
         Array GetValues(string variable);
 
+        /// <summary>
+        /// Gets variable values by index (flattened nD index).
+        /// </summary>
+        /// <param name="variable"></param>
+        /// <param name="index"></param>
+        /// <returns></returns>
+        Array GetValues(string variable, int[] index);
+
+        /// <summary>
+        /// Gets variable values by slice (flattened nD array of Rank x NumberOfValues).
+        /// </summary>
+        /// <param name="variable"></param>
+        /// <param name="start"></param>
+        /// <param name="count"></param>
+        /// <returns></returns>
+        Array GetValues(string variable, int[] start, int[] count);
+
+        /// <summary>
+        /// Sets variable values.
+        /// </summary>
+        /// <param name="variable"></param>
+        /// <param name="values"></param>
         void SetValues(string variable, Array values);
 
+        /// <summary>
+        /// Sets variable values by slice (start + count for every dimension).
+        /// </summary>
+        /// <param name="variable"></param>
+        /// <param name="start"></param>
+        /// <param name="count"></param>
+        /// <param name="values"></param>
         void SetValues(string variable, int[] start, int[] count, Array values);
 
-        Logger Logger { get; set; }
+        /// <summary>
+        /// Sets variable values by indices (flattened nD array of Rank x NumberOfValues).
+        /// </summary>
+        /// <param name="variable"></param>
+        /// <param name="index"></param>
+        /// <param name="values"></param>
+        void SetValues(string variable, int[] index, Array values);
     }
 }

Diff for: src/BasicModelInterfaceRunner/App.config

@@ -1,6 +1,6 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8"?>
 <configuration>
     <startup> 
-        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
+        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/>
     </startup>
-</configuration>
+</configuration>

Diff for: src/BasicModelInterfaceRunner/BasicModelInterfaceRunner.csproj

@@ -9,8 +9,9 @@
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <RootNamespace>BasicModelInterfaceRunner</RootNamespace>
     <AssemblyName>bmi-runner</AssemblyName>
-    <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
+    <TargetFrameworkVersion>v4.0</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
+    <TargetFrameworkProfile />
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <PlatformTarget>AnyCPU</PlatformTarget>