Revit_Core_Engine: Element Checkout Status Query Added

Revit_Core_Engine/Compute/Notes.cs

@@ -35,16 +35,20 @@ public static partial class Compute
 
         internal static void MaterialNotInLibraryNote(this Material material)
         {
-            string message = "Material could not be found in BHoM Libary.";
+            string message = "Material could not be found in BHoM Library.";
 
             if (material != null)
                 message = string.Format("{0} Material Id: {1}", message, material.Id.IntegerValue);
 
             BH.Engine.Base.Compute.RecordNote(message);
         }
 
+        internal static void ElementOwnedByCurrentUserNote(Element element)
+        {
+            BH.Engine.Base.Compute.RecordNote($"Revit object with ElementId: {element.Id} is owned by the current user.");
+        }
         /***************************************************/
     }
-}
+}  
 
 

Revit_Core_Engine/Compute/Warnings.cs

@@ -514,6 +514,13 @@ internal static void TransformNotImplementedWarning(this Element element)
         }
 
         /***************************************************/
+
+        internal static void ElementOwnedByOtherUserWarning(Element element)
+        {
+            BH.Engine.Base.Compute.RecordWarning($"Revit object could not be updated or modified due to its CheckoutStatus. Revit ElementId: {element.Id} is owned by another user.");
+        }
+
+        /***************************************************/
     }
 }
 

Revit_Core_Engine/Modify/Checkout.cs

@@ -0,0 +1,78 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2022, 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 Autodesk.Revit.DB;
+using BH.oM.Base.Attributes;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Linq;
+
+namespace BH.Revit.Engine.Core
+{
+    public static partial class Modify
+    {
+        /***************************************************/
+        /****              Public methods               ****/
+        /***************************************************/
+
+        [Description("Modifies CheckoutStatus for each element selected if element is not currently owned by the current user or others.")]
+        [Input("elements", "Revit elements to query for its checkout status.")]
+        [Output("elementsCheckedOut", "List of elements checked out (ownership modified to be by current user) by this process.")]
+        public static List<Element> Checkout(this List<Element> elements)
+        {
+            if (elements == null)
+            {
+                BH.Engine.Base.Compute.RecordError("Check out process of list of elements failed because the list of elements provided was null.");
+                return null;
+            }
+
+            List<Element> elementsToCheckout = new List<Element>();
+
+            foreach (Element element in elements)
+            {
+                switch (element.CheckoutStatus())
+                {
+                    case CheckoutStatus.NotOwned:
+                        elementsToCheckout.Add(element);
+                        break;
+                    case CheckoutStatus.OwnedByCurrentUser:
+                        Compute.ElementOwnedByCurrentUserNote(element);
+                        break;
+                    case CheckoutStatus.OwnedByOtherUser:
+                        Compute.ElementOwnedByOtherUserWarning(element);
+                        break;
+                }
+            }
+
+            foreach (var group in elementsToCheckout.GroupBy(x => x.Document))
+            {
+                WorksharingUtils.CheckoutElements(group.Key, group.Select(x => x.Id).ToList());
+            }
+
+            return elementsToCheckout;
+        }
+        /***************************************************/
+    }
+}
+
+
+

Revit_Core_Engine/Modify/SetInsulation.cs

@@ -36,7 +36,7 @@ public static partial class Modify
         /****              Public methods               ****/
         /***************************************************/
 
-        [Description("Add or update existing insulation of the duct or pipe with given inuslation type and thickness.")]
+        [Description("Add or update existing insulation of the duct or pipe with given insulation type and thickness.")]
         [Input("host", "Host element to add or update the insulation on.")]
         [Input("insulationType", "Type of insulation to be added or updated on the host object. Null value removes insulation from the host if it exist.")]
         [Input("insulationThickness", "Thickness of insulation to be added or updated on the host object.")]

Revit_Core_Engine/Query/CheckoutStatus.cs

@@ -0,0 +1,55 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2022, 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 Autodesk.Revit.DB;
+using Autodesk.Revit.DB.Analysis;
+using Autodesk.Revit.UI;
+using BH.Engine.Adapters.Revit;
+using BH.oM.Base;
+using BH.oM.Base.Attributes;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Linq;
+
+namespace BH.Revit.Engine.Core
+{
+    public static partial class Query
+    {
+        /***************************************************/
+        /****              Public methods               ****/
+        /***************************************************/
+
+        [Description("Returns element CheckoutStatus.")]
+        [Input("element", "Revit element to query for its checkout status.")]
+        [Output("checkoutStatus", "The worksharing ownership/CheckoutStatus of the element.")]
+        public static CheckoutStatus? CheckoutStatus(this Element element)
+        {
+            if (element == null)
+            {
+                BH.Engine.Base.Compute.RecordError("Querying checkout status of element failed because the element provided was null.");
+                return null;
+            }
+            return WorksharingUtils.GetCheckoutStatus(element.Document, element.Id);
+        }
+        /***************************************************/
+    }
+}

Revit_Core_Engine/Query/ElementsEditablePerCheckoutStatus.cs

@@ -0,0 +1,70 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2022, 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 Autodesk.Revit.DB;
+using Autodesk.Revit.DB.Analysis;
+using Autodesk.Revit.UI;
+using BH.Engine.Adapters.Revit;
+using BH.oM.Base;
+using BH.oM.Base.Attributes;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Linq;
+
+namespace BH.Revit.Engine.Core
+{
+    public static partial class Query
+    {
+        /***************************************************/
+        /****              Public methods               ****/
+        /***************************************************/
+        [Description("Returns a sublist of elements, from the given list of elements, that are editable per the element's CheckoutStatus. " +
+            "Return warnings option, if true, alerts the user of which elements are uneditable due to ownership by other users.")]
+        [Input("elements", "Revit elements to query for its checkout status.")]
+        [Input("recordWarnings", "If it is desired, a value of 'True' will raise warnings on which elements "
+            + "in the list are uneditable due to ownership by other users.")]
+        [Output("elementsEditablePerCheckoutStatus", "List of elements that are editable per the element's CheckoutStatus.")]
+        public static List<Element> ElementsEditablePerCheckoutStatus(this List<Element> elements, bool recordWarnings)
+        {
+            if (elements == null)
+            {
+                BH.Engine.Base.Compute.RecordError("Querying checkout status of list of elements for editable status failed because the list of elements provided was null.");
+                return null;
+            }
+
+            List<Element> elementsOwnedByOthers = elements.ElementsOwnedByOtherUsers().ToList();
+
+            List<Element> editableElements = elements.Except(elementsOwnedByOthers).ToList();
+
+            if (recordWarnings)
+            {
+                foreach (var element in elementsOwnedByOthers)
+                {
+                    Compute.ElementOwnedByOtherUserWarning(element);
+                }
+            }
+
+            return editableElements;
+        }
+        /***************************************************/
+    }
+}

Revit_Core_Engine/Query/ElementsOwnedByCurrentUser.cs

@@ -0,0 +1,56 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2022, 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 Autodesk.Revit.DB;
+using Autodesk.Revit.DB.Analysis;
+using Autodesk.Revit.UI;
+using BH.Engine.Adapters.Revit;
+using BH.oM.Base;
+using BH.oM.Base.Attributes;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Linq;
+
+namespace BH.Revit.Engine.Core
+{
+    public static partial class Query
+    {
+        /***************************************************/
+        /****              Public methods               ****/
+        /***************************************************/
+
+        [Description("Returns a sublist of elements, from the given list of elements, that are owned by the current user.")]
+        [Input("elements", "Revit elements to query for its checkout status.")]
+        [Output("elementsOwnedByCurrentUser", "List of elements that are owned by the current user.")]
+        public static List<Element> ElementsOwnedByCurrentUser(this List<Element> elements)
+        {
+            if (elements == null)
+            {
+                BH.Engine.Base.Compute.RecordError("Querying checkout status of list of elements for ownership by current user failed because the list of elements provided was null.");
+                return null;
+            }
+
+            return elements.Where(e => e.IsOwnedByCurrentUser()).ToList();
+        }
+        /***************************************************/
+    }
+}

Revit_Core_Engine/Query/ElementsOwnedByNone.cs

@@ -0,0 +1,55 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2022, 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 Autodesk.Revit.DB;
+using Autodesk.Revit.DB.Analysis;
+using Autodesk.Revit.UI;
+using BH.Engine.Adapters.Revit;
+using BH.oM.Base;
+using BH.oM.Base.Attributes;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Linq;
+
+namespace BH.Revit.Engine.Core
+{
+    public static partial class Query
+    {
+        /***************************************************/
+        /****              Public methods               ****/
+        /***************************************************/
+        [Description("Returns a sublist of elements, from the given list of elements, that are unowned.")]
+        [Input("elements", "Revit elements to query for its checkout status.")]
+        [Output("elementsOwnedByNone", "List of elements that are unowned.")]
+        public static List<Element> ElementsOwnedByNone(this List<Element> elements)
+        {
+            if (elements == null)
+            {
+                BH.Engine.Base.Compute.RecordError("Querying checkout status of list of elements for ownership by none failed because the list of elements provided was null.");
+                return null;
+            }
+
+            return elements.Where(e => e.IsOwnedByNone() == true).ToList();
+        }
+        /***************************************************/
+    }
+}