cost.copy_cost_schedule #6901

A feature allowing duplicate existing IfcCostSchedule - either from API or from Bonsai UI
Button location in Bonsai - https://files.catbox.moe/ct058q.png

src/bonsai/bonsai/bim/module/cost/__init__.py

@@ -37,6 +37,7 @@ classes = (
     operator.ContractCostItemRate,
     operator.ContractCostItems,
     operator.CopyCostItem,
+    operator.CopyCostSchedule,
     operator.CopyCostItemValues,
     operator.DisableEditingCostItem,
     operator.DisableEditingCostItemQuantity,

src/bonsai/bonsai/bim/module/cost/operator.py

@@ -82,6 +82,20 @@ class RemoveCostSchedule(bpy.types.Operator, tool.Ifc.Operator):
         core.remove_cost_schedule(tool.Ifc, tool.Cost, cost_schedule=tool.Ifc.get().by_id(self.cost_schedule))
 
 
+class CopyCostSchedule(bpy.types.Operator, tool.Ifc.Operator):
+    bl_idname = "bim.copy_cost_schedule"
+    bl_label = "Copy Cost Schedule"
+    bl_description = "Create a duplicate of the provided cost schedule."
+    bl_options = {"REGISTER", "UNDO"}
+    cost_schedule: bpy.props.IntProperty()  # pyright: ignore[reportRedeclaration]
+
+    if TYPE_CHECKING:
+        cost_schedule: int
+
+    def _execute(self, context):
+        core.copy_cost_schedule(tool.Cost, cost_schedule=tool.Ifc.get().by_id(self.cost_schedule))
+
+
 class EnableEditingCostSchedule(bpy.types.Operator):
     bl_idname = "bim.enable_editing_cost_schedule_attributes"
     bl_label = "Enable Editing Cost Schedule"

src/bonsai/bonsai/bim/module/cost/ui.py

@@ -129,6 +129,7 @@ class BIM_PT_cost_schedules(Panel):
             row.operator("bim.enable_editing_cost_schedule_attributes", text="", icon="GREASEPENCIL").cost_schedule = (
                 cost_schedule["id"]
             )
+            row.operator("bim.copy_cost_schedule", text="", icon="DUPLICATE").cost_schedule = cost_schedule["id"]
             row.operator("bim.remove_cost_schedule", text="", icon="X").cost_schedule = cost_schedule["id"]
         if self.props.active_cost_schedule_id == cost_schedule["id"]:
             if self.props.is_editing == "COST_SCHEDULE_ATTRIBUTES":

src/bonsai/bonsai/core/cost.py

@@ -48,6 +48,10 @@ def remove_cost_schedule(
     ifc.run("cost.remove_cost_schedule", cost_schedule=cost_schedule)
 
 
+def copy_cost_schedule(cost: type[tool.Cost], cost_schedule: ifcopenshell.entity_instance) -> None:
+    cost.copy_cost_schedule(cost_schedule)
+
+
 def enable_editing_cost_schedule_attributes(cost: type[tool.Cost], cost_schedule: ifcopenshell.entity_instance) -> None:
     cost.load_cost_schedule_attributes(cost_schedule)
     cost.enable_editing_cost_schedule_attributes(cost_schedule)

src/bonsai/bonsai/tool/cost.py

@@ -1114,3 +1114,9 @@ class Cost(bonsai.core.tool.Cost):
         if results["quantity_type"] == "IfcQuantityCount":
             results["unit_symbol"] = "U"
         return results
+
+    @classmethod
+    def copy_cost_schedule(cls, cost_schedule: ifcopenshell.entity_instance) -> None:
+        ifc_file = tool.Ifc.get()
+        new_schedule = ifcopenshell.api.cost.copy_cost_schedule(ifc_file, cost_schedule=cost_schedule)
+        new_schedule.Name = (cost_schedule.Name or "Unnamed") + " Copy"

src/ifcopenshell-python/ifcopenshell/api/cost/__init__.py

@@ -34,6 +34,7 @@ from .assign_cost_value import assign_cost_value
 from .calculate_cost_item_resource_value import calculate_cost_item_resource_value
 from .copy_cost_item import copy_cost_item
 from .copy_cost_item_values import copy_cost_item_values
+from .copy_cost_schedule import copy_cost_schedule
 from .edit_cost_item import edit_cost_item
 from .edit_cost_item_quantity import edit_cost_item_quantity
 from .edit_cost_schedule import edit_cost_schedule
@@ -57,6 +58,7 @@ __all__ = [
     "calculate_cost_item_resource_value",
     "copy_cost_item",
     "copy_cost_item_values",
+    "copy_cost_schedule",
     "edit_cost_item",
     "edit_cost_item_quantity",
     "edit_cost_schedule",

src/ifcopenshell-python/ifcopenshell/api/cost/copy_cost_schedule.py

@@ -0,0 +1,48 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of IfcOpenShell.
+#
+# IfcOpenShell 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 of the License, or
+# (at your option) any later version.
+#
+# IfcOpenShell 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 IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+
+import ifcopenshell.api.control
+import ifcopenshell.api.cost
+import ifcopenshell.util.element
+
+
+def copy_cost_schedule(
+    file: ifcopenshell.file, cost_schedule: ifcopenshell.entity_instance
+) -> ifcopenshell.entity_instance:
+    """Copy a cost schedule.
+
+    :param cost_schedule: IfcCostSchedule to copy.
+    :return: The duplicated IfcCostSchedule entity
+
+    Example:
+
+    .. code:: python
+
+        schedule = ifcopenshell.api.cost.add_cost_schedule(model)
+        new_schedule = ifcopenshell.api.cost.copy_cost_schedule(schedule)
+    """
+    new_schedule = ifcopenshell.util.element.copy(file, cost_schedule)
+
+    for rel in cost_schedule.Controls:
+        for cost_item in rel.RelatedObjects:
+            duplicated_cost_item = ifcopenshell.api.cost.copy_cost_item(file, cost_item)
+            if isinstance(duplicated_cost_item, list):
+                # All other nested items are not connected to the cost schedule explicitly.
+                duplicated_cost_item = duplicated_cost_item[0]
+            ifcopenshell.api.control.assign_control(file, new_schedule, duplicated_cost_item)
+    return new_schedule