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

2026-08-19 19:54:07 +00:00 · 2024-05-06 14:35:39 +10:00
parent 10f894e2ea
commit d11ec67129
330 changed files with 13283 additions and 13751 deletions
@@ -21,54 +21,51 @@ import ifcopenshell.api
 import ifcopenshell.util.element


-class Usecase:
-    def __init__(self, file, relating_control=None, related_object=None):
-        """Unassigns a planning control or constraint to an object
+def unassign_control(file, relating_control=None, related_object=None) -> None:
+    """Unassigns a planning control or constraint to an object

-        :param relating_control: The IfcControl entity that is creating the
-            control or constraint
-        :type relating_control: ifcopenshell.entity_instance
-        :param related_object: The IfcObjectDefinition that is being controlled
-        :type related_object: ifcopenshell.entity_instance
-        :return: If the control still is related to other objects, the
-            IfcRelAssignsToControl is returned, otherwise None.
-        :rtype: ifcopenshell.entity_instance, None
+    :param relating_control: The IfcControl entity that is creating the
+        control or constraint
+    :type relating_control: ifcopenshell.entity_instance
+    :param related_object: The IfcObjectDefinition that is being controlled
+    :type related_object: ifcopenshell.entity_instance
+    :return: If the control still is related to other objects, the
+        IfcRelAssignsToControl is returned, otherwise None.
+    :rtype: ifcopenshell.entity_instance, None

-        Example:
+    Example:

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

-            # Let's relate a cost item and a product
-            wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            cost_item = ifcopenshell.api.run("cost.add_cost_item", model,
-                cost_schedule=schedule)
-            ifcopenshell.api.run("control.assign_control", model,
-                relating_control=cost_item, related_object=wall)
+        # Let's relate a cost item and a product
+        wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        cost_item = ifcopenshell.api.run("cost.add_cost_item", model,
+            cost_schedule=schedule)
+        ifcopenshell.api.run("control.assign_control", model,
+            relating_control=cost_item, related_object=wall)

-            # And now let's change our mind
-            ifcopenshell.api.run("control.unassign_control", model,
-                relating_control=cost_item, related_object=wall)
-        """
+        # And now let's change our mind
+        ifcopenshell.api.run("control.unassign_control", model,
+            relating_control=cost_item, related_object=wall)
+    """

-        self.file = file
-        self.settings = {
-            "relating_control": relating_control,
-            "related_object": related_object,
-        }
+    settings = {
+        "relating_control": relating_control,
+        "related_object": related_object,
+    }

-    def execute(self):
-        for rel in self.settings["related_object"].HasAssignments or []:
-            if not rel.is_a("IfcRelAssignsToControl") or rel.RelatingControl != self.settings["relating_control"]:
-                continue
-            if len(rel.RelatedObjects) == 1:
-                history = rel.OwnerHistory
-                self.file.remove(rel)
-                if history:
-                    ifcopenshell.util.element.remove_deep2(self.file, history)
-                return
-            related_objects = list(rel.RelatedObjects)
-            related_objects.remove(self.settings["related_object"])
-            rel.RelatedObjects = related_objects
-            ifcopenshell.api.run("owner.update_owner_history", self.file, **{"element": rel})
-            return rel
+    for rel in settings["related_object"].HasAssignments or []:
+        if not rel.is_a("IfcRelAssignsToControl") or rel.RelatingControl != settings["relating_control"]:
+            continue
+        if len(rel.RelatedObjects) == 1:
+            history = rel.OwnerHistory
+            file.remove(rel)
+            if history:
+                ifcopenshell.util.element.remove_deep2(file, history)
+            return
+        related_objects = list(rel.RelatedObjects)
+        related_objects.remove(settings["related_object"])
+        rel.RelatedObjects = related_objects
+        ifcopenshell.api.run("owner.update_owner_history", file, **{"element": rel})
+        return rel