First Commit

2026-05-31 10:17:09 +07:00
commit 17a9c69379
4547 changed files with 1170384 additions and 0 deletions
@@ -0,0 +1,56 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of IfcOpenShell.
+#
+# IfcOpenShell is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# IfcOpenShell is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+
+from typing import Optional
+
+import ifcopenshell
+import ifcopenshell.api.owner
+import ifcopenshell.guid
+
+
+def add_group(
+    file: ifcopenshell.file, name: str = "Unnamed", description: Optional[str] = None
+) -> ifcopenshell.entity_instance:
+    """Adds a new group
+
+    An IFC group is an arbitrary collection of products, which are typically
+    physical. It may be used when there is no other more specific group
+    which may be used. Other types of groups include distribution systems,
+    which group together products that are connected and circulate a medium
+    (such as fluid or electricity), or zones, which group together spaces,
+    or structural load groups, which group together loads for structural
+    analysis, or inventories, which are groups of assets.
+
+    :param name: The name of the group. Defaults to "Unnamed"
+    :param description: The description of the purpose of the group.
+    :return: The newly created IfcGroup
+
+    Example:
+
+    .. code:: python
+
+        ifcopenshell.api.group.add_group(model, name="Unit 1A")
+    """
+
+    return file.create_entity(
+        "IfcGroup",
+        GlobalId=ifcopenshell.guid.new(),
+        OwnerHistory=ifcopenshell.api.owner.create_owner_history(file),
+        Name=name,
+        Description=description,
+    )