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

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


-class Usecase:
-    def __init__(self, file):
-        """Add empty georeferencing entities to a model
+def add_georeferencing(file) -> None:
+    """Add empty georeferencing entities to a model

-        By default, models are not georeferenced. Georeferencing requires two
-        entities: a definition of the projected coordinated reference system
-        (CRS) used, and the transformation parameters between any local coordinate
-        system and that projected CRS if any.
+    By default, models are not georeferenced. Georeferencing requires two
+    entities: a definition of the projected coordinated reference system
+    (CRS) used, and the transformation parameters between any local coordinate
+    system and that projected CRS if any.

-        This function will create the entities to store the projected CRS and
-        map conversion transformation, but will leave all the parameters blank.
-        It is this the users responsibility to specify the correct
-        georeferencing parameters. See
-        ifcopenshell.api.georeference.edit_georeferencing.
+    This function will create the entities to store the projected CRS and
+    map conversion transformation, but will leave all the parameters blank.
+    It is this the users responsibility to specify the correct
+    georeferencing parameters. See
+    ifcopenshell.api.georeference.edit_georeferencing.

-        :return: None
-        :rtype: None
+    :return: None
+    :rtype: None

-        Example:
+    Example:

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

-            ifcopenshell.api.run("georeference.add_georeferencing", model)
-        """
-        self.file = file
+        ifcopenshell.api.run("georeference.add_georeferencing", model)
+    """

-    def execute(self):
-        source_crs = None
-        for context in self.file.by_type("IfcGeometricRepresentationContext", include_subtypes=False):
-            if context.ContextType == "Model":
-                source_crs = context
-                break
-        if not source_crs:
-            return
-        projected_crs = self.file.create_entity("IfcProjectedCRS", **{"Name": ""})
-        self.file.create_entity(
-            "IfcMapConversion",
-            **{
-                "SourceCRS": source_crs,
-                "TargetCRS": projected_crs,
-                "Eastings": 0,
-                "Northings": 0,
-                "OrthogonalHeight": 0,
-            }
-        )
+    source_crs = None
+    for context in file.by_type("IfcGeometricRepresentationContext", include_subtypes=False):
+        if context.ContextType == "Model":
+            source_crs = context
+            break
+    if not source_crs:
+        return
+    projected_crs = file.create_entity("IfcProjectedCRS", **{"Name": ""})
+    file.create_entity(
+        "IfcMapConversion",
+        **{
+            "SourceCRS": source_crs,
+            "TargetCRS": projected_crs,
+            "Eastings": 0,
+            "Northings": 0,
+            "OrthogonalHeight": 0,
+        }
+    )