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

2026-08-12 18:43:26 +00:00 · 2024-05-06 14:35:39 +10:00
parent 10f894e2ea
commit d11ec67129
330 changed files with 13283 additions and 13751 deletions
@@ -21,70 +21,66 @@ import ifcopenshell.api
 import ifcopenshell.util.element


-class Usecase:
-    def __init__(
-        self,
-        file: ifcopenshell.file,
-        products: list[ifcopenshell.entity_instance],
-        relating_structure: ifcopenshell.entity_instance,
-    ):
-        """Dereferences a list of products and space
+def dereference_structure(
+    file: ifcopenshell.file,
+    products: list[ifcopenshell.entity_instance],
+    relating_structure: ifcopenshell.entity_instance,
+) -> None:
+    """Dereferences a list of products and space

-        :param products: The list of physical IfcElements that exists in the space.
-        :type products: list[ifcopenshell.entity_instance]
-        :param relating_structure: The IfcSpatialStructureElement element, such
-            as IfcBuilding, IfcBuildingStorey, or IfcSpace that the element
-            exists in.
-        :return: None
-        :rtype: None
+    :param products: The list of physical IfcElements that exists in the space.
+    :type products: list[ifcopenshell.entity_instance]
+    :param relating_structure: The IfcSpatialStructureElement element, such
+        as IfcBuilding, IfcBuildingStorey, or IfcSpace that the element
+        exists in.
+    :return: None
+    :rtype: None

-        Example:
+    Example:

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

-            project = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcProject")
-            site = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcSite")
-            building = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuilding")
-            storey1 = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuildingStorey")
-            storey2 = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuildingStorey")
-            storey3 = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuildingStorey")
+        project = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcProject")
+        site = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcSite")
+        building = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuilding")
+        storey1 = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuildingStorey")
+        storey2 = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuildingStorey")
+        storey3 = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuildingStorey")

-            # The project contains a site (note that project aggregation is a special case in IFC)
-            ifcopenshell.api.run("aggregate.assign_object", model, products=[site], relating_object=project)
+        # The project contains a site (note that project aggregation is a special case in IFC)
+        ifcopenshell.api.run("aggregate.assign_object", model, products=[site], relating_object=project)

-            # The site has a building, the building has a storey, and the storey has a space
-            ifcopenshell.api.run("aggregate.assign_object", model, products=[building], relating_object=site)
-            ifcopenshell.api.run("aggregate.assign_object", model, products=[storey], relating_object=building)
-            ifcopenshell.api.run("aggregate.assign_object", model, products=[space], relating_object=storey)
+        # The site has a building, the building has a storey, and the storey has a space
+        ifcopenshell.api.run("aggregate.assign_object", model, products=[building], relating_object=site)
+        ifcopenshell.api.run("aggregate.assign_object", model, products=[storey], relating_object=building)
+        ifcopenshell.api.run("aggregate.assign_object", model, products=[space], relating_object=storey)

-            # Create a column, this column spans 3 storeys
-            column = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
+        # Create a column, this column spans 3 storeys
+        column = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")

-            # The column is contained in the lowermost storey
-            ifcopenshell.api.run("spatial.assign_container", model, products=[column], relating_structure=storey1)
+        # The column is contained in the lowermost storey
+        ifcopenshell.api.run("spatial.assign_container", model, products=[column], relating_structure=storey1)

-            # And referenced in the others
-            ifcopenshell.api.run("spatial.reference_structure", model, products=[column], relating_structure=storey2)
-            ifcopenshell.api.run("spatial.reference_structure", model, products=[column], relating_structure=storey3)
+        # And referenced in the others
+        ifcopenshell.api.run("spatial.reference_structure", model, products=[column], relating_structure=storey2)
+        ifcopenshell.api.run("spatial.reference_structure", model, products=[column], relating_structure=storey3)

-            # Actually, it only goes up to storey 2.
-            ifcopenshell.api.run("spatial.dereference_structure", model, products=[column], relating_structure=storey3)
-        """
-        self.file = file
-        self.settings = {"products": products, "relating_structure": relating_structure}
+        # Actually, it only goes up to storey 2.
+        ifcopenshell.api.run("spatial.dereference_structure", model, products=[column], relating_structure=storey3)
+    """
+    settings = {"products": products, "relating_structure": relating_structure}

-    def execute(self) -> None:
-        products = set(self.settings["products"])
-        for rel in self.settings["relating_structure"].ReferencesElements:
-            related_elements = set(rel.RelatedElements)
-            if not related_elements.intersection(products):
-                continue
-            related_elements = related_elements - products
-            if related_elements:
-                rel.RelatedElements = list(related_elements)
-                ifcopenshell.api.run("owner.update_owner_history", self.file, **{"element": rel})
-            else:
-                history = rel.OwnerHistory
-                self.file.remove(rel)
-                if history:
-                    ifcopenshell.util.element.remove_deep2(self.file, history)
+    products = set(settings["products"])
+    for rel in settings["relating_structure"].ReferencesElements:
+        related_elements = set(rel.RelatedElements)
+        if not related_elements.intersection(products):
+            continue
+        related_elements = related_elements - products
+        if related_elements:
+            rel.RelatedElements = list(related_elements)
+            ifcopenshell.api.run("owner.update_owner_history", file, **{"element": rel})
+        else:
+            history = rel.OwnerHistory
+            file.remove(rel)
+            if history:
+                ifcopenshell.util.element.remove_deep2(file, history)