First Commit

2026-05-31 10:17:09 +07:00
commit 17a9c69379
4547 changed files with 1170384 additions and 0 deletions
@@ -0,0 +1,135 @@
+# 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
+import ifcopenshell.api.nest
+import ifcopenshell.api.project
+import ifcopenshell.api.pset
+import ifcopenshell.api.sequence
+import ifcopenshell.util.element
+
+
+def remove_task(file: ifcopenshell.file, task: ifcopenshell.entity_instance) -> None:
+    """Removes a task
+
+    All subtasks are also removed recursively. Any relationships such as
+    sequences or controls are also removed.
+
+    :param task: The IfcTask to remove.
+    :return: None
+
+    Example:
+
+    .. code:: python
+
+        # Let's imagine we are creating a construction schedule. All tasks
+        # need to be part of a work schedule.
+        schedule = ifcopenshell.api.sequence.add_work_schedule(model, name="Construction Schedule A")
+
+        # Add a root task to represent the design milestones, and major
+        # project phases.
+        ifcopenshell.api.sequence.add_task(model,
+            work_schedule=schedule, name="Milestones", identification="A")
+        design = ifcopenshell.api.sequence.add_task(model,
+            work_schedule=schedule, name="Design", identification="B")
+        ifcopenshell.api.sequence.add_task(model,
+            work_schedule=schedule, name="Construction", identification="C")
+
+        # Ah, let's delete the design section, who needs it anyway we'll
+        # just fix it on site.
+        ifcopenshell.api.sequence.remove_task(model, task=design)
+    """
+    # TODO: do a deep purge
+    ifcopenshell.api.project.unassign_declaration(
+        file,
+        definitions=[task],
+        relating_context=file.by_type("IfcContext")[0],
+    )
+    if task_time := task.TaskTime:
+        if task_time.is_a("IfcTaskTimeRecurring"):
+            ifcopenshell.api.sequence.unassign_recurrence_pattern(file, task_time.Recurrence)
+        file.remove(task_time)
+
+    # Handle IfcRelNests.
+    if rels := task.IsNestedBy:
+        subtasks = rels[0].RelatedObjects
+        # Use batching for optimization.
+        ifcopenshell.api.nest.unassign_object(file, subtasks)
+        for task_ in subtasks:
+            ifcopenshell.api.sequence.remove_task(file, task=task_)
+    if task.Nests:
+        ifcopenshell.api.nest.unassign_object(file, [task])
+
+    for inverse in file.get_inverse(task):
+        if inverse.is_a("IfcRelSequence"):
+            history = inverse.OwnerHistory
+            file.remove(inverse)
+            if history:
+                ifcopenshell.util.element.remove_deep2(file, history)
+        elif inverse.is_a("IfcRelAssignsToControl"):
+            if inverse.RelatingControl == task or len(inverse.RelatedObjects) == 1:
+                history = inverse.OwnerHistory
+                file.remove(inverse)
+                if history:
+                    ifcopenshell.util.element.remove_deep2(file, history)
+            else:
+                related_objects = list(inverse.RelatedObjects)
+                related_objects.remove(task)
+                inverse.RelatedObjects = related_objects
+        elif inverse.is_a("IfcRelDefinesByProperties"):
+            ifcopenshell.api.pset.remove_pset(
+                file,
+                product=task,
+                pset=inverse.RelatingPropertyDefinition,
+            )
+        elif inverse.is_a("IfcRelAssignsToProcess"):
+            if inverse.RelatingProcess == task or len(inverse.RelatedObjects) == 1:
+                history = inverse.OwnerHistory
+                file.remove(inverse)
+                if history:
+                    ifcopenshell.util.element.remove_deep2(file, history)
+        elif inverse.is_a("IfcRelAssignsToProduct"):
+            if inverse.RelatingProduct == task or len(inverse.RelatedObjects) == 1:
+                history = inverse.OwnerHistory
+                file.remove(inverse)
+                if history:
+                    ifcopenshell.util.element.remove_deep2(file, history)
+            else:
+                related_objects = list(inverse.RelatedObjects)
+                related_objects.remove(task)
+                inverse.RelatedObjects = related_objects
+        elif inverse.is_a("IfcRelAssignsToObject"):
+            if inverse.RelatingObject == task or len(inverse.RelatedObjects) == 1:
+                history = inverse.OwnerHistory
+                file.remove(inverse)
+                if history:
+                    ifcopenshell.util.element.remove_deep2(file, history)
+            else:
+                related_objects = list(inverse.RelatedObjects)
+                related_objects.remove(task)
+                inverse.RelatedObjects = related_objects
+        elif inverse.is_a("IfcRelAssignsToProcess"):
+            history = inverse.OwnerHistory
+            file.remove(inverse)
+            if history:
+                ifcopenshell.util.element.remove_deep2(file, history)
+
+    history = task.OwnerHistory
+    file.remove(task)
+    if history:
+        ifcopenshell.util.element.remove_deep2(file, history)