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

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


-class Usecase:
-    def __init__(self, file, port=None):
-        """Disconnects a port from any other port
+def disconnect_port(file, port=None) -> None:
+    """Disconnects a port from any other port

-        A port may only be connected to one other port, so the other port is not
-        needed to be specified.
+    A port may only be connected to one other port, so the other port is not
+    needed to be specified.

-        :param port: The IfcDistributionPort to disconnect.
-        :type port: ifcopenshell.entity_instance
-        :return: None
-        :rtype: None
+    :param port: The IfcDistributionPort to disconnect.
+    :type port: ifcopenshell.entity_instance
+    :return: None
+    :rtype: None

-        Example:
+    Example:

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

-            # A completely empty distribution system
-            system = ifcopenshell.api.run("system.add_system", model)
+        # A completely empty distribution system
+        system = ifcopenshell.api.run("system.add_system", model)

-            # Create a duct and a 90 degree bend fitting
-            duct = ifcopenshell.api.run("root.create_entity", model,
-                ifc_class="IfcDuctSegment", predefined_type="RIGIDSEGMENT")
-            fitting = ifcopenshell.api.run("root.create_entity", model,
-                ifc_class="IfcDuctFitting", predefined_type="BEND")
+        # Create a duct and a 90 degree bend fitting
+        duct = ifcopenshell.api.run("root.create_entity", model,
+            ifc_class="IfcDuctSegment", predefined_type="RIGIDSEGMENT")
+        fitting = ifcopenshell.api.run("root.create_entity", model,
+            ifc_class="IfcDuctFitting", predefined_type="BEND")

-            # The duct and fitting is part of the system
-            ifcopenshell.api.run("system.assign_system", model, products=[duct], system=system)
-            ifcopenshell.api.run("system.assign_system", model, products=[fitting], system=system)
+        # The duct and fitting is part of the system
+        ifcopenshell.api.run("system.assign_system", model, products=[duct], system=system)
+        ifcopenshell.api.run("system.assign_system", model, products=[fitting], system=system)

-            # Create 2 ports, one for either end of both the duct and fitting.
-            duct_port1 = ifcopenshell.api.run("system.add_port", model, element=duct)
-            duct_port2 = ifcopenshell.api.run("system.add_port", model, element=duct)
-            fitting_port1 = ifcopenshell.api.run("system.add_port", model, element=fitting)
-            fitting_port2 = ifcopenshell.api.run("system.add_port", model, element=fitting)
+        # Create 2 ports, one for either end of both the duct and fitting.
+        duct_port1 = ifcopenshell.api.run("system.add_port", model, element=duct)
+        duct_port2 = ifcopenshell.api.run("system.add_port", model, element=duct)
+        fitting_port1 = ifcopenshell.api.run("system.add_port", model, element=fitting)
+        fitting_port2 = ifcopenshell.api.run("system.add_port", model, element=fitting)

-            # Connect the duct and fitting together. At this point, we have not
-            # yet determined the direction of the flow, so we leave direction as
-            # NOTDEFINED.
-            ifcopenshell.api.run("system.connect_port", model, port1=duct_port2, port2=fitting_port1)
+        # Connect the duct and fitting together. At this point, we have not
+        # yet determined the direction of the flow, so we leave direction as
+        # NOTDEFINED.
+        ifcopenshell.api.run("system.connect_port", model, port1=duct_port2, port2=fitting_port1)

-            # Disconnect the port. note we could've equally disconnected
-            # fitting_port1 instead of duct_port2
-            ifcopenshell.api.run("system.disconnect_port", model, port=duct_port2)
-        """
-        self.file = file
-        self.settings = {
-            "port": port,
-        }
+        # Disconnect the port. note we could've equally disconnected
+        # fitting_port1 instead of duct_port2
+        ifcopenshell.api.run("system.disconnect_port", model, port=duct_port2)
+    """
+    settings = {
+        "port": port,
+    }

-    def execute(self):
-        rels = self.settings["port"].ConnectedTo or ()
-        rels += self.settings["port"].ConnectedFrom or ()
+    rels = settings["port"].ConnectedTo or ()
+    rels += settings["port"].ConnectedFrom or ()

-        for rel in rels:
-            rel.RelatingPort.FlowDirection = None
-            rel.RelatedPort.FlowDirection = None
-            history = rel.OwnerHistory
-            self.file.remove(rel)
-            if history:
-                ifcopenshell.util.element.remove_deep2(self.file, history)
+    for rel in rels:
+        rel.RelatingPort.FlowDirection = None
+        rel.RelatedPort.FlowDirection = None
+        history = rel.OwnerHistory
+        file.remove(rel)
+        if history:
+            ifcopenshell.util.element.remove_deep2(file, history)