BHoM_Engine: Add methods to query the current event log suppression state (#3307)

Author: Fraser Greenroyd

BHoM_Engine/Compute/RecordEvent.cs

@@ -114,7 +114,7 @@ public static bool RecordEvent(Event newEvent)
                     OnEventRecorded(newEvent); //Only raise an event if we're not in switched off mode
             }
 
-            if (newEvent.Type == EventType.Error && m_ThrowError && !m_SuppressError) //Only throw the event as an exception if someone has asked us to throw it, AND we aren't suppressing them
+            if (newEvent.Type == EventType.Error && m_ThrowError) //Only throw the event as an exception if someone has asked us to throw it
                 throw new Exception(newEvent.ToText());
 
             return true;
@@ -145,11 +145,11 @@ private static void OnEventRecorded(Event ev)
         /**** Private Variables                         ****/
         /***************************************************/
 
-        private static bool m_SuppressError = false; //Default to false, do not suppress any events which come through the system
-        private static bool m_SuppressWarning = false;
-        private static bool m_SuppressNote = false;
+        internal static bool m_SuppressError { get; private set; } = false; //Default to false, do not suppress any events which come through the system
+        internal static bool m_SuppressWarning { get; private set; } = false;
+        internal static bool m_SuppressNote { get; private set; } = false;
 
-        private static bool m_ThrowError = false; //Default to false - do not throw errors as exceptions. However, if a user (developer user or UI user) has unsuppressed this, then errors will be thrown for try/catch statements to handle.
+        internal static bool m_ThrowError { get; private set; } = false; //Default to false - do not throw errors as exceptions. However, if a user (developer user or UI user) has unsuppressed this, then errors will be thrown for try/catch statements to handle.
         //ToDo: Discuss whether we want this to be true by default and have BHoM_UI switch it off on load, or keep as is. FYI @alelom
     }
 }

BHoM_Engine/Query/IsSuppressing.cs

@@ -0,0 +1,67 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2024, 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.oM.Base;
+using BH.oM.Base.Attributes;
+using System.ComponentModel;
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Linq;
+using System.Runtime.CompilerServices;
+
+namespace BH.Engine.Base
+{
+    public static partial class Query
+    {
+        /***************************************************/
+        /**** Public Methods                            ****/
+        /***************************************************/
+
+        [Description("Find out if the system is currently suppressing error recording in the main log or not.")]
+        [Output("errorSuppression", "True if errors are currently being suppressed, false if they are being recorded normally.")]
+        public static bool IsSuppressingErrors()
+        {
+            return Compute.m_SuppressError;
+        }
+
+        /***************************************************/
+
+        [Description("Find out if the system is currently suppressing warning recording in the main log or not.")]
+        [Output("warningSuppression", "True if warnings are currently being suppressed, false if they are being recorded normally.")]
+        public static bool IsSuppressingWarnings()
+        {
+            return Compute.m_SuppressWarning;
+        }
+
+        /***************************************************/
+
+        [Description("Find out if the system is currently suppressing note recording in the main log or not.")]
+        [Output("noteSuppression", "True if notes are currently being suppressed, false if they are being recorded normally.")]
+        public static bool IsSuppressingNotes()
+        {
+            return Compute.m_SuppressNote;
+        }
+
+        /***************************************************/
+    }
+}

BHoM_Engine/Query/IsThrowingErrors.cs

@@ -0,0 +1,47 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2024, 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.oM.Base;
+using BH.oM.Base.Attributes;
+using System.ComponentModel;
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Linq;
+using System.Runtime.CompilerServices;
+
+namespace BH.Engine.Base
+{
+    public static partial class Query
+    {
+        /***************************************************/
+        /**** Public Methods                            ****/
+        /***************************************************/
+
+        [Description("Find out if the system is currently throwing errors as exceptions when recorded to the main log or not.")]
+        [Output("throwingErrors", "True if errors are currently being thrown as exceptions, false if they are just being recorded in the log normally.")]
+        public static bool IsThrowingErrors()
+        {
+            return Compute.m_ThrowError;
+        }
+    }
+}