Made ToolkitSettings explicitly IImmutable (#79)

Author: Fraser Greenroyd

BHoMAnalytics_Engine/Compute/CollectUsageData.cs

@@ -28,6 +28,7 @@
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using BH.oM.Base.Attributes;
 
 namespace BH.Engine.BHoMAnalytics
 {
@@ -37,6 +38,8 @@ public static partial class Compute
         /**** Public Methods                            ****/
         /***************************************************/
 
+        [Input("deleteProcessedFiles", "Whether the method should delete processed log files or not.")]
+        [Output("entries", "The list of processed usage entries.")]
         public static List<UsageEntry> CollectUsageData(bool deleteProcessedFiles = false)
         {
             string logFolder = @"C:\ProgramData\BHoM\Logs";

BHoMAnalytics_Engine/Compute/SummariseUsageData.cs

@@ -28,6 +28,7 @@
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using BH.oM.Base.Attributes;
 
 namespace BH.Engine.BHoMAnalytics
 {
@@ -37,6 +38,8 @@ public static partial class Compute
         /**** Public Methods                            ****/
         /***************************************************/
 
+        [Input("logEntries", "The list of logged usage entries to summarise.")]
+        [Output("usageEntries", "A list of summarised usage entries.")]
         public static List<UsageEntry> SummariseUsageData(this List<UsageLogEntry> logEntries)
         {
             string computer = Environment.MachineName;

BHoMAnalytics_Engine/Create/ToolkitSettings.cs

@@ -42,9 +42,10 @@ public static partial class Create
         [Input("serverAddress", "Connection string of the Mongo server in charge of storing teh analytics data. Be aware that this generally includes the port number.")]
         [Input("databaseName", "Name of the database on the Mongo server that will contain the analytics data.")]
         [Input("collectionName", "Name of the collection inside that database that will contain the analytics data.")]
-        public static ToolkitSettings ToolkitSettings(string serverAddress, string databaseName, string collectionName)
+        [Input("initialisationMethod", "Method signature of the method creating this ToolkitSettings.")]
+        public static ToolkitSettings ToolkitSettings(string serverAddress, string databaseName, string collectionName, string initialisationMethod)
         {
-            return new ToolkitSettings(serverAddress, databaseName, collectionName);
+            return new ToolkitSettings(serverAddress, databaseName, collectionName, initialisationMethod);
         }
 
         /***************************************************/

BHoMAnalytics_oM/ToolkitSettings.cs

@@ -33,7 +33,7 @@
 namespace BH.oM.BHoMAnalytics
 {
     [Description("Settings for the BHoMAnalytics toolkit. This contains the reference to the database where to save the analytics data as well as the method in charge to do so.")]
-    public class ToolkitSettings : BHoMObject, ISettings, IInitialisationSettings
+    public class ToolkitSettings : BHoMObject, ISettings, IInitialisationSettings, IImmutable
     {
         /***************************************************/
         /**** Properties                                ****/
@@ -56,11 +56,12 @@ public class ToolkitSettings : BHoMObject, ISettings, IInitialisationSettings
         /**** Constructors                              ****/
         /***************************************************/
 
-        public ToolkitSettings(string serverAddress, string databaseName, string collectionName)
+        public ToolkitSettings(string serverAddress, string databaseName, string collectionName, string initialisationMethod)
         {
             ServerAddress = serverAddress;
             DatabaseName = databaseName;
             CollectionName = collectionName;
+            InitialisationMethod = initialisationMethod;
         }
 
         /***************************************************/