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

2026-08-13 02:47:48 +00:00 · 2024-05-06 14:35:39 +10:00
parent 10f894e2ea
commit d11ec67129
330 changed files with 13283 additions and 13751 deletions
@@ -19,50 +19,47 @@
 import ifcopenshell.util.date


-class Usecase:
-    def __init__(self, file, resource=None):
-        """Adds the time that a resource is used for
+def add_resource_time(file, resource=None) -> None:
+    """Adds the time that a resource is used for

-        For labour and equipment resources, the total duration that the resource
-        is used for may be stored. This may either be input manually or
-        calculated parametrically. This is known as the resource time, and may
-        be used to calculate other parameters like resource utilisation.
+    For labour and equipment resources, the total duration that the resource
+    is used for may be stored. This may either be input manually or
+    calculated parametrically. This is known as the resource time, and may
+    be used to calculate other parameters like resource utilisation.

-        :param resource: The IfcConstructionResource to record time for.
-        :type resource: ifcopenshell.entity_instance
-        :return: The newly created IfcResourceTime
-        :rtype: ifcopenshell.entity_instance
+    :param resource: The IfcConstructionResource to record time for.
+    :type resource: ifcopenshell.entity_instance
+    :return: The newly created IfcResourceTime
+    :rtype: ifcopenshell.entity_instance

-        Example:
+    Example:

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

-            # Add our own crew
-            crew = ifcopenshell.api.run("resource.add_resource", model, ifc_class="IfcCrewResource")
+        # Add our own crew
+        crew = ifcopenshell.api.run("resource.add_resource", model, ifc_class="IfcCrewResource")

-            # Add some labour to our crew.
-            labour = ifcopenshell.api.run("resource.add_resource", model,
-                parent_resource=crew, ifc_class="IfcLaborResource")
+        # Add some labour to our crew.
+        labour = ifcopenshell.api.run("resource.add_resource", model,
+            parent_resource=crew, ifc_class="IfcLaborResource")

-            # Labour resource is quantified in terms of time.
-            quantity = ifcopenshell.api.run("resource.add_resource_quantity", model,
-                resource=labour, ifc_class="IfcQuantityTime")
+        # Labour resource is quantified in terms of time.
+        quantity = ifcopenshell.api.run("resource.add_resource_quantity", model,
+            resource=labour, ifc_class="IfcQuantityTime")

-            # Store the unit time used in hours
-            ifcopenshell.api.run("resource.edit_resource_quantity", model,
-                physical_quantity=quantity, attributes={"TimeValue": 8.0})
+        # Store the unit time used in hours
+        ifcopenshell.api.run("resource.edit_resource_quantity", model,
+            physical_quantity=quantity, attributes={"TimeValue": 8.0})

-            # Let's imagine we've used the resource for 2 days.
-            time = ifcopenshell.api.run("resource.add_resource_time", model, resource=labour)
-            ifcopenshell.api.run("resource.edit_resource_time", model,
-                resource_time=time, attributes={"ScheduleWork": "PT16H"})
-        """
-        self.file = file
-        self.settings = {
-            "resource": resource,
-        }
+        # Let's imagine we've used the resource for 2 days.
+        time = ifcopenshell.api.run("resource.add_resource_time", model, resource=labour)
+        ifcopenshell.api.run("resource.edit_resource_time", model,
+            resource_time=time, attributes={"ScheduleWork": "PT16H"})
+    """
+    settings = {
+        "resource": resource,
+    }

-    def execute(self):
-        resource_time = self.file.create_entity("IfcResourceTime")
-        self.settings["resource"].Usage = resource_time
-        return resource_time
+    resource_time = file.create_entity("IfcResourceTime")
+    settings["resource"].Usage = resource_time
+    return resource_time