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

2026-08-10 09:48:32 +00:00 · 2024-05-06 14:35:39 +10:00
parent 10f894e2ea
commit d11ec67129
330 changed files with 13283 additions and 13751 deletions
@@ -17,51 +17,48 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.


-class Usecase:
-    def __init__(self, file, layer=None, attributes=None, material=None):
-        """Edits the attributes of an IfcMaterialLayer
+def edit_layer(file, layer=None, attributes=None, material=None) -> None:
+    """Edits the attributes of an IfcMaterialLayer

-        For more information about the attributes and data types of an
-        IfcMaterialLayer, consult the IFC documentation.
+    For more information about the attributes and data types of an
+    IfcMaterialLayer, consult the IFC documentation.

-        :param layer: The IfcMaterialLayer entity you want to edit
-        :type layer: ifcopenshell.entity_instance
-        :param attributes: a dictionary of attribute names and values.
-        :type attributes: dict, optional
-        :param material: The IfcMaterial entity you want the layer to be made
-            from.
-        :type material: ifcopenshell.entity_instance, optional
-        :return: None
-        :rtype: None
+    :param layer: The IfcMaterialLayer entity you want to edit
+    :type layer: ifcopenshell.entity_instance
+    :param attributes: a dictionary of attribute names and values.
+    :type attributes: dict, optional
+    :param material: The IfcMaterial entity you want the layer to be made
+        from.
+    :type material: ifcopenshell.entity_instance, optional
+    :return: None
+    :rtype: None

-        Example:
+    Example:

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

-            # Let's create two materials typically used for steel stud partition
-            # walls with gypsum lining.
-            gypsum = ifcopenshell.api.run("material.add_material", model, name="PB01", category="gypsum")
-            steel = ifcopenshell.api.run("material.add_material", model, name="ST01", category="steel")
+        # Let's create two materials typically used for steel stud partition
+        # walls with gypsum lining.
+        gypsum = ifcopenshell.api.run("material.add_material", model, name="PB01", category="gypsum")
+        steel = ifcopenshell.api.run("material.add_material", model, name="ST01", category="steel")

-            # Create a material layer set to contain our layers.
-            material_set = ifcopenshell.api.run("material.add_material_set", model,
-                name="GYP-ST-GYP", set_type="IfcMaterialLayerSet")
+        # Create a material layer set to contain our layers.
+        material_set = ifcopenshell.api.run("material.add_material_set", model,
+            name="GYP-ST-GYP", set_type="IfcMaterialLayerSet")

-            # Now let's use those materials as three layers in our set, such
-            # that the steel studs are sandwiched by the gypsum. Let's imagine
-            # we're setting the layer thickness in millimeters.
-            layer = ifcopenshell.api.run("material.add_layer", model, layer_set=material_set, material=gypsum)
-            ifcopenshell.api.run("material.edit_layer", model, layer=layer, attributes={"LayerThickness": 13})
-            layer = ifcopenshell.api.run("material.add_layer", model, layer_set=material_set, material=steel)
-            ifcopenshell.api.run("material.edit_layer", model, layer=layer, attributes={"LayerThickness": 92})
-            layer = ifcopenshell.api.run("material.add_layer", model, layer_set=material_set, material=gypsum)
-            ifcopenshell.api.run("material.edit_layer", model, layer=layer, attributes={"LayerThickness": 13})
-        """
-        self.file = file
-        self.settings = {"layer": layer, "attributes": attributes or {}, "material": material}
+        # Now let's use those materials as three layers in our set, such
+        # that the steel studs are sandwiched by the gypsum. Let's imagine
+        # we're setting the layer thickness in millimeters.
+        layer = ifcopenshell.api.run("material.add_layer", model, layer_set=material_set, material=gypsum)
+        ifcopenshell.api.run("material.edit_layer", model, layer=layer, attributes={"LayerThickness": 13})
+        layer = ifcopenshell.api.run("material.add_layer", model, layer_set=material_set, material=steel)
+        ifcopenshell.api.run("material.edit_layer", model, layer=layer, attributes={"LayerThickness": 92})
+        layer = ifcopenshell.api.run("material.add_layer", model, layer_set=material_set, material=gypsum)
+        ifcopenshell.api.run("material.edit_layer", model, layer=layer, attributes={"LayerThickness": 13})
+    """
+    settings = {"layer": layer, "attributes": attributes or {}, "material": material}

-    def execute(self):
-        for name, value in self.settings["attributes"].items():
-            setattr(self.settings["layer"], name, value)
-        if self.settings["material"]:
-            self.settings["layer"].Material = self.settings["material"]
+    for name, value in settings["attributes"].items():
+        setattr(settings["layer"], name, value)
+    if settings["material"]:
+        settings["layer"].Material = settings["material"]