Fix #1576. Managing IfcSystem subtypes is now possible.

src/ifcopenshell-python/Makefile

@@ -9,8 +9,8 @@ qa:
 
 .PHONY: license
 license:
-	#copyright-header --license LGPL3 --copyright-holder "Thomas Krijnen <thomas@aecgeeks.com>" --copyright-year "2021" --copyright-software "IfcOpenShell" --copyright-software-description "IFC toolkit and geometry engine" -a ./ -o ./
-	copyright-header --license LGPL3 --copyright-holder "Dion Moult <dion@thinkmoult.com>" --copyright-year "2021" --copyright-software "IfcOpenShell" --copyright-software-description "IFC toolkit and geometry engine" -a ./ -o ./
+	#copyright-header --license LGPL3 --copyright-holder "Thomas Krijnen <thomas@aecgeeks.com>" --copyright-year "2022" --copyright-software "IfcOpenShell" --copyright-software-description "IFC toolkit and geometry engine" -a ./ -o ./
+	copyright-header --license LGPL3 --copyright-holder "Dion Moult <dion@thinkmoult.com>" --copyright-year "2022" --copyright-software "IfcOpenShell" --copyright-software-description "IFC toolkit and geometry engine" -a ./ -o ./
 
 .PHONY: coverage
 coverage:

src/ifcopenshell-python/ifcopenshell/api/system/add_system.py

@@ -23,13 +23,13 @@ import ifcopenshell.api
 class Usecase:
     def __init__(self, file, **settings):
         self.file = file
-        self.settings = {}
+        self.settings = {"ifc_class": "IfcSystem"}
         for key, value in settings.items():
             self.settings[key] = value
 
     def execute(self):
         return self.file.create_entity(
-            "IfcSystem",
+            self.settings["ifc_class"],
             **{
                 "GlobalId": ifcopenshell.guid.new(),
                 "OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", self.file),

src/ifcopenshell-python/ifcopenshell/util/system.py

@@ -0,0 +1,36 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2022 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/>.
+
+
+def get_system_elements(system):
+    results = []
+    for rel in system.IsGroupedBy:
+        results.extend(rel.RelatedObjects)
+    return results
+
+
+def get_element_systems(element):
+    results = []
+    for rel in element.HasAssignments:
+        if rel.is_a("IfcRelAssignsToGroup") and rel.RelatingGroup.is_a() in [
+            "IfcSystem",
+            "IfcDistributionSystem",
+            "IfcBuildingSystem",
+        ]:
+            results.append(rel.RelatingGroup)
+    return results

src/ifcopenshell-python/test/api/system/test_add_system.py

@@ -0,0 +1,28 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2022 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/>.
+
+import test.bootstrap
+import ifcopenshell.api
+
+
+class TestAddSystem(test.bootstrap.IFC4):
+    def test_adding_a_system(self):
+        system = ifcopenshell.api.run("system.add_system", self.file, ifc_class="IfcSystem")
+        system2 = ifcopenshell.api.run("system.add_system", self.file, ifc_class="IfcDistributionSystem")
+        assert system.is_a("IfcSystem")
+        assert system2.is_a("IfcDistributionSystem")

src/ifcopenshell-python/test/api/system/test_remove_system.py

@@ -0,0 +1,27 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2022 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/>.
+
+import test.bootstrap
+import ifcopenshell.api
+
+
+class TestRemoveSystem(test.bootstrap.IFC4):
+    def test_removing_a_system(self):
+        system = ifcopenshell.api.run("system.add_system", self.file, ifc_class="IfcSystem")
+        ifcopenshell.api.run("system.remove_system", self.file, system=system)
+        assert len(self.file.by_type("IfcSystem")) == 0

src/ifcopenshell-python/test/util/test_system.py

@@ -0,0 +1,47 @@
+# 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/>.
+
+import pytest
+import test.bootstrap
+import ifcopenshell.api
+import ifcopenshell.util.system as subject
+
+
+class TestGetSystemElements(test.bootstrap.IFC4):
+    def test_run(self):
+        element = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcPump")
+        system = ifcopenshell.api.run("system.add_system", self.file, ifc_class="IfcSystem")
+        ifcopenshell.api.run("system.assign_system", self.file, product=element, system=system)
+        assert subject.get_system_elements(system) == [element]
+
+
+class TestGetElementSystems(test.bootstrap.IFC4):
+    def test_run(self):
+        element = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcPump")
+        system = ifcopenshell.api.run("system.add_system", self.file, ifc_class="IfcSystem")
+        ifcopenshell.api.run("system.assign_system", self.file, product=element, system=system)
+        assert subject.get_element_systems(element) == [system]
+
+    def test_do_not_get_non_services_groups(self):
+        element = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcPump")
+        ifcopenshell.api.run("system.assign_system", self.file, product=element, system=self.file.createIfcGroup())
+        ifcopenshell.api.run("system.assign_system", self.file, product=element, system=self.file.createIfcZone())
+        ifcopenshell.api.run(
+            "system.assign_system", self.file, product=element, system=self.file.createIfcStructuralAnalysisModel()
+        )
+        assert not subject.get_element_systems(element)