Adapter methods: Serialisation to and from ladybug objects (#142)

Author: Fraser Greenroyd

LadybugTools_Adapter/AdapterActions/Pull.cs

@@ -0,0 +1,72 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ *
+ * Each contributor holds copyright over their respective contributions.
+ * The project versioning (Git) records all such contribution source information.
+ *                                           
+ *                                                                              
+ * The BHoM is free software: you can redistribute it and/or modify         
+ * it under the terms of the GNU Lesser General Public License as published by  
+ * the Free Software Foundation, either version 3.0 of the License, or          
+ * (at your option) any later version.                                          
+ *                                                                              
+ * The BHoM is distributed in the hope that it will be useful,              
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of               
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                 
+ * GNU Lesser General Public License for more details.                          
+ *                                                                            
+ * You should have received a copy of the GNU Lesser General Public License     
+ * along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.      
+ */
+
+using BH.Engine.Adapter;
+using BH.oM.Adapter;
+using BH.oM.Base;
+using BH.oM.Data.Requests;
+using BH.oM.LadybugTools;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace BH.Adapter.LadybugTools
+{
+    public partial class LadybugToolsAdapter : BHoMAdapter
+    {
+        public override IEnumerable<object> Pull(IRequest request, PullType pullType = PullType.AdapterDefault, ActionConfig actionConfig = null) 
+        {
+            if (actionConfig == null)
+            {
+                BH.Engine.Base.Compute.RecordError("Please provide a valid LadybugConfig ActionConfig.");
+                return new List<IBHoMObject>();
+            }
+
+            LadybugConfig config = actionConfig as LadybugConfig;
+            if (config == null)
+            {
+                BH.Engine.Base.Compute.RecordError($"The type of actionConfig provided: {actionConfig.GetType().FullName} is not valid for this adapter. Please provide a valid LadybugConfig actionConfig.");
+                return new List<IBHoMObject>();
+            }
+
+            if (config.JsonFile == null)
+            {
+                BH.Engine.Base.Compute.RecordError("Please provide a valid JsonFile FileSettings object.");
+                return new List<IBHoMObject>();
+            }
+
+            if (!System.IO.File.Exists(config.JsonFile.GetFullFileName()))
+            {
+                BH.Engine.Base.Compute.RecordError($"The file at {config.JsonFile.GetFullFileName()} does not exist to pull from.");
+                return new List<IBHoMObject>();
+            }
+
+            if (request != null)
+            {
+                FilterRequest filterRequest = request as FilterRequest;
+                return Read(filterRequest.Type, actionConfig: config);
+            }
+            else
+                return Read(null, config);
+        }
+    }
+}

LadybugTools_Adapter/AdapterActions/Push.cs

@@ -0,0 +1,70 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ *
+ * Each contributor holds copyright over their respective contributions.
+ * The project versioning (Git) records all such contribution source information.
+ *                                           
+ *                                                                              
+ * The BHoM is free software: you can redistribute it and/or modify         
+ * it under the terms of the GNU Lesser General Public License as published by  
+ * the Free Software Foundation, either version 3.0 of the License, or          
+ * (at your option) any later version.                                          
+ *                                                                              
+ * The BHoM is distributed in the hope that it will be useful,              
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of               
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                 
+ * GNU Lesser General Public License for more details.                          
+ *                                                                            
+ * You should have received a copy of the GNU Lesser General Public License     
+ * along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.      
+ */
+
+using BH.Engine.Adapter;
+using BH.Engine.LadybugTools;
+using BH.oM.Adapter;
+using BH.oM.Base;
+using BH.oM.Data.Requests;
+using BH.oM.LadybugTools;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+namespace BH.Adapter.LadybugTools
+{
+    public partial class LadybugToolsAdapter : BHoMAdapter
+    {
+        public override List<object> Push(IEnumerable<object> objects, string tag = "", PushType pushType = PushType.AdapterDefault, ActionConfig actionConfig = null)
+        {
+            if (actionConfig == null)
+            {
+                BH.Engine.Base.Compute.RecordError("Please provide a valid LadybugConfig ActionConfig.");
+                return new List<object>();
+            }
+
+            LadybugConfig config = actionConfig as LadybugConfig;
+            if (config == null)
+            {
+                BH.Engine.Base.Compute.RecordError("Please input a valid LadybugConfig.");
+                return new List<object>();
+            }
+
+            if (objects.Count() == 0)
+            {
+                BH.Engine.Base.Compute.RecordError("Please input a valid LadybugTools object.");
+                return new List<object>();
+            }
+
+            List<ILadybugTools> lbtObjects = objects.Where(x => typeof(ILadybugTools).IsAssignableFrom(x.GetType())).Cast<ILadybugTools>().ToList();
+
+            if (lbtObjects.Count() < objects.Count())
+            {
+                BH.Engine.Base.Compute.RecordWarning("The LadybugTools Toolkit adapter does not support converting non-ILadybugTools objects to json, skipping all objects that are not an ILadybugTools");
+            }
+
+            CreateLadybug(lbtObjects, config);
+            return objects.Where(x => typeof(ILadybugTools).IsAssignableFrom(x.GetType())).ToList();
+        }
+    }
+}

LadybugTools_Adapter/CRUD/CreateLadybug.cs

@@ -0,0 +1,50 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ *
+ * Each contributor holds copyright over their respective contributions.
+ * The project versioning (Git) records all such contribution source information.
+ *                                           
+ *                                                                              
+ * The BHoM is free software: you can redistribute it and/or modify         
+ * it under the terms of the GNU Lesser General Public License as published by  
+ * the Free Software Foundation, either version 3.0 of the License, or          
+ * (at your option) any later version.                                          
+ *                                                                              
+ * The BHoM is distributed in the hope that it will be useful,              
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of               
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                 
+ * GNU Lesser General Public License for more details.                          
+ *                                                                            
+ * You should have received a copy of the GNU Lesser General Public License     
+ * along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.      
+ */
+
+using BH.Engine.Adapter;
+using BH.oM.Adapter;
+using BH.oM.Base.Debugging;
+using BH.oM.LadybugTools;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+
+namespace BH.Adapter.LadybugTools
+{
+    public partial class LadybugToolsAdapter : BHoMAdapter
+    {
+        public static void CreateLadybug(List<ILadybugTools> objects, LadybugConfig config = null)
+        {
+            List<string> jsonObjects = new List<string>();
+            
+            foreach (ILadybugTools lbtObject in objects)
+            {
+                jsonObjects.Add(lbtObject.FromBHoM());
+            }
+
+            string json = "[" + string.Join(", ", jsonObjects) + "]";
+            File.WriteAllText(config.JsonFile.GetFullFileName(), json);
+        }
+    }
+}

LadybugTools_Adapter/CRUD/Read.cs

@@ -0,0 +1,43 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ *
+ * Each contributor holds copyright over their respective contributions.
+ * The project versioning (Git) records all such contribution source information.
+ *                                           
+ *                                                                              
+ * The BHoM is free software: you can redistribute it and/or modify         
+ * it under the terms of the GNU Lesser General Public License as published by  
+ * the Free Software Foundation, either version 3.0 of the License, or          
+ * (at your option) any later version.                                          
+ *                                                                              
+ * The BHoM is distributed in the hope that it will be useful,              
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of               
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                 
+ * GNU Lesser General Public License for more details.                          
+ *                                                                            
+ * You should have received a copy of the GNU Lesser General Public License     
+ * along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.      
+ */
+
+using BH.Engine.Adapter;
+using BH.Engine.Serialiser;
+using BH.oM.Adapter;
+using BH.oM.Base;
+using BH.oM.LadybugTools;
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Text;
+
+namespace BH.Adapter.LadybugTools
+{
+    public partial class LadybugToolsAdapter : BHoMAdapter
+    {
+        protected override IEnumerable<IBHoMObject> IRead(Type type, IList indices = null, ActionConfig actionConfig = null)
+        {
+            LadybugConfig config = actionConfig as LadybugConfig;
+            return config.JsonFile.ToBHoM();
+        }
+    }
+}

LadybugTools_Adapter/Convert/Collections/EPW.cs

@@ -0,0 +1,104 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ *
+ * Each contributor holds copyright over their respective contributions.
+ * The project versioning (Git) records all such contribution source information.
+ *                                           
+ *                                                                              
+ * The BHoM is free software: you can redistribute it and/or modify         
+ * it under the terms of the GNU Lesser General Public License as published by  
+ * the Free Software Foundation, either version 3.0 of the License, or          
+ * (at your option) any later version.                                          
+ *                                                                              
+ * The BHoM is distributed in the hope that it will be useful,              
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of               
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                 
+ * GNU Lesser General Public License for more details.                          
+ *                                                                            
+ * You should have received a copy of the GNU Lesser General Public License     
+ * along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.      
+ */
+
+using BH.Engine.Serialiser;
+using BH.oM.Base;
+using BH.oM.LadybugTools;
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Linq;
+using System.Text;
+
+namespace BH.Adapter.LadybugTools
+{
+    public static partial class Convert
+    {
+        public static BH.oM.LadybugTools.EPW ToEPW(Dictionary<string, object> oldObject)
+        {
+            Location location = new Location();
+            Dictionary<string, object> metaData = new Dictionary<string, object>();
+
+            try
+            {
+                if (oldObject["location"].GetType() == typeof(CustomObject))
+                    oldObject["location"] = (oldObject["location"] as CustomObject).CustomData;
+                location = ToLocation(oldObject["location"] as Dictionary<string, object>);
+            }
+            catch (Exception ex)
+            {
+                BH.Engine.Base.Compute.RecordError($"An error occurred when reading the Location of the EPW. returning a default Location.\n The error: {ex}");
+            }
+
+            try
+            {
+                if (oldObject["metadata"].GetType() == typeof(CustomObject))
+                    oldObject["metadata"] = (oldObject["metadata"] as CustomObject).CustomData;
+                metaData = (Dictionary<string, object>)oldObject["metadata"];
+            }
+            catch (Exception ex)
+            {
+                BH.Engine.Base.Compute.RecordError($"An error occurred when reading the meta data of the EPW. returning an empty metadata object.\n The error: {ex}");
+            }
+
+            List<BH.oM.LadybugTools.HourlyContinuousCollection> collections = new List<BH.oM.LadybugTools.HourlyContinuousCollection>();
+
+            if (oldObject.ContainsKey("data_collections"))
+            {
+                foreach (var collection in oldObject["data_collections"] as List<object>)
+                {
+                    if (collection.GetType() == typeof(CustomObject))
+                        collections.Add(ToHourlyContinuousCollection((collection as CustomObject).CustomData));
+                    else
+                        collections.Add(ToHourlyContinuousCollection(collection as Dictionary<string, object>));
+                }
+            }
+            else
+            {
+                BH.Engine.Base.Compute.RecordError($"Could not find any data collections for this EPW object. Returning an empty list.");
+            }
+            
+            return new EPW()
+            {
+                Location = location,
+                DataCollections = collections,
+                Metadata = metaData
+            };
+
+        }
+        
+        public static string FromEPW(BH.oM.LadybugTools.EPW epw)
+        {
+            string type = "EPW";
+            string location = FromLocation(epw.Location).ToJson();
+            string dataCollections = string.Join(", ", epw.DataCollections.Select(x => FromHourlyContinuousCollection(x)));
+            string metadata = epw.Metadata.ToJson();
+
+            if (metadata.Length == 0)
+                metadata = "{}";
+
+            string json = @"{ ""type"": """ + type + @""", ""location"": " + location + @", ""data_collections"": [ " + dataCollections + @"], ""metadata"": " + metadata + "}";
+
+            return json;
+        }
+    }
+}