Generate functions for all API usecases for better static code features. See #2693.

2026-08-09 17:31:45 +00:00 · 2024-05-06 14:35:39 +10:00
parent 10f894e2ea
commit d11ec67129
330 changed files with 13283 additions and 13751 deletions
@@ -21,69 +21,66 @@ import ifcopenshell.api
 import ifcopenshell.util.element


-class Usecase:
-    def __init__(self, file, work_schedule=None):
-        """Removes a work schedule
+def remove_work_schedule(file, work_schedule=None) -> None:
+    """Removes a work schedule

-        All tasks in the work schedule are also removed recursively.
+    All tasks in the work schedule are also removed recursively.

-        :param work_schedule: The IfcWorkSchedule to remove.
-        :type work_schedule: ifcopenshell.entity_instance
-        :return: None
-        :rtype: None
+    :param work_schedule: The IfcWorkSchedule to remove.
+    :type work_schedule: ifcopenshell.entity_instance
+    :return: None
+    :rtype: None

-        Example:
+    Example:

-        .. code:: python
+    .. code:: python

-            # This will hold all our construction schedules
-            work_plan = ifcopenshell.api.run("sequence.add_work_plan", model, name="Construction")
+        # This will hold all our construction schedules
+        work_plan = ifcopenshell.api.run("sequence.add_work_plan", model, name="Construction")

-            # Let's imagine this is one of our schedules in our work plan.
-            schedule = ifcopenshell.api.run("sequence.add_work_schedule", model,
-                name="Construction Schedule A", work_plan=work_plan)
+        # Let's imagine this is one of our schedules in our work plan.
+        schedule = ifcopenshell.api.run("sequence.add_work_schedule", model,
+            name="Construction Schedule A", work_plan=work_plan)

-            # And remove it immediately
-            ifcopenshell.api.run("sequence.remove_work_schedule", model, work_schedule=schedule)
-        """
-        self.file = file
-        self.settings = {"work_schedule": work_schedule}
+        # And remove it immediately
+        ifcopenshell.api.run("sequence.remove_work_schedule", model, work_schedule=schedule)
+    """
+    settings = {"work_schedule": work_schedule}

-    def execute(self):
-        # TODO: do a deep purge
-        ifcopenshell.api.run(
-            "project.unassign_declaration",
-            self.file,
-            definitions=[self.settings["work_schedule"]],
-            relating_context=self.file.by_type("IfcContext")[0],
-        )
-        if self.settings["work_schedule"].Declares:
-            for rel in self.settings["work_schedule"].Declares:
-                for work_schedule in rel.RelatedObjects:
-                    ifcopenshell.api.run(
-                        "sequence.remove_work_schedule",
-                        self.file,
-                        work_schedule=work_schedule,
-                    )
-        for inverse in self.file.get_inverse(self.settings["work_schedule"]):
-            if inverse.is_a("IfcRelDefinesByObject"):
-                if inverse.RelatingObject == self.settings["work_schedule"] or len(inverse.RelatedObjects) == 1:
-                    history = inverse.OwnerHistory
-                    self.file.remove(inverse)
-                    if history:
-                        ifcopenshell.util.element.remove_deep2(self.file, history)
-                else:
-                    related_objects = list(inverse.RelatedObjects)
-                    related_objects.remove(self.settings["work_schedule"])
-                    inverse.RelatedObjects = related_objects
-            elif inverse.is_a("IfcRelAssignsToControl"):
-                [
-                    ifcopenshell.api.run("sequence.remove_task", self.file, task=related_object)
-                    for related_object in inverse.RelatedObjects
-                    if related_object.is_a("IfcTask")
-                ]
+    # TODO: do a deep purge
+    ifcopenshell.api.run(
+        "project.unassign_declaration",
+        file,
+        definitions=[settings["work_schedule"]],
+        relating_context=file.by_type("IfcContext")[0],
+    )
+    if settings["work_schedule"].Declares:
+        for rel in settings["work_schedule"].Declares:
+            for work_schedule in rel.RelatedObjects:
+                ifcopenshell.api.run(
+                    "sequence.remove_work_schedule",
+                    file,
+                    work_schedule=work_schedule,
+                )
+    for inverse in file.get_inverse(settings["work_schedule"]):
+        if inverse.is_a("IfcRelDefinesByObject"):
+            if inverse.RelatingObject == settings["work_schedule"] 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(settings["work_schedule"])
+                inverse.RelatedObjects = related_objects
+        elif inverse.is_a("IfcRelAssignsToControl"):
+            [
+                ifcopenshell.api.run("sequence.remove_task", file, task=related_object)
+                for related_object in inverse.RelatedObjects
+                if related_object.is_a("IfcTask")
+            ]

-        history = self.settings["work_schedule"].OwnerHistory
-        self.file.remove(self.settings["work_schedule"])
-        if history:
-            ifcopenshell.util.element.remove_deep2(self.file, history)
+    history = settings["work_schedule"].OwnerHistory
+    file.remove(settings["work_schedule"])
+    if history:
+        ifcopenshell.util.element.remove_deep2(file, history)