constraint.assign_constraint - support batching #4474

src/ifcopenshell-python/test/api/constraint/test_assign_constraint.py

@@ -0,0 +1,64 @@
+# 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 pytest
+import test.bootstrap
+import ifcopenshell.api
+import ifcopenshell.util.constraint
+
+
+class TestAssignConstraint(test.bootstrap.IFC4):
+    def test_assign_a_constraint(self):
+        element = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
+        element2 = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
+        constraint = ifcopenshell.api.run("constraint.add_objective", self.file)
+        ifcopenshell.api.run(
+            "constraint.assign_constraint", self.file, products=[element, element2], constraint=constraint
+        )
+        assert ifcopenshell.util.constraint.get_constrained_elements(constraint) == {element, element2}
+        assert len(self.file.by_type("IfcRelAssociatesConstraint")) == 1
+
+    def test_doing_nothing_if_the_constraint_is_already_assigned(self):
+        constraint = ifcopenshell.api.run("constraint.add_objective", self.file)
+        element = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
+        element2 = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
+        ifcopenshell.api.run(
+            "constraint.assign_constraint", self.file, products=[element, element2], constraint=constraint
+        )
+        total_elements = len([e for e in self.file])
+        ifcopenshell.api.run(
+            "constraint.assign_constraint", self.file, products=[element, element2], constraint=constraint
+        )
+        assert len([e for e in self.file]) == total_elements
+
+    def test_that_old_relationships_are_updated_if_they_still_contain_elements(self):
+        constraint = ifcopenshell.api.run("constraint.add_objective", self.file)
+        element1 = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
+        ifcopenshell.api.run("constraint.assign_constraint", self.file, products=[element1], constraint=constraint)
+        rel = self.file.by_type("IfcRelAssociatesConstraint")[0]
+
+        element2 = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
+        element3 = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
+        ifcopenshell.api.run(
+            "constraint.assign_constraint", self.file, products=[element2, element3], constraint=constraint
+        )
+        assert len(rel.RelatedObjects) == 3
+
+
+class TestAssignConstraintIFC2X3(test.bootstrap.IFC2X3, TestAssignConstraint):
+    pass

src/ifcopenshell-python/test/api/test_api.py

@@ -19,6 +19,7 @@
 import test.bootstrap
 import ifcopenshell.api
 import ifcopenshell.util.classification
+import ifcopenshell.util.constraint
 import ifcopenshell.util.element
 import ifcopenshell.util.system
 from datetime import datetime
@@ -285,6 +286,15 @@ class TestTemporarySupportForDeprecatedAPIArguments(test.bootstrap.IFC4):
     def test_removing_a_container(self):
         element = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcBuilding")
         subelement = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
-        ifcopenshell.api.run("spatial.reference_structure", self.file, products=[subelement], relating_structure=element)
+        ifcopenshell.api.run(
+            "spatial.reference_structure", self.file, products=[subelement], relating_structure=element
+        )
         ifcopenshell.api.run("spatial.dereference_structure", self.file, product=subelement, relating_structure=element)
         assert ifcopenshell.util.element.get_referenced_structures(subelement) == []
+
+    @deprecation_check
+    def test_assign_a_constraint(self):
+        element = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
+        constraint = ifcopenshell.api.run("constraint.add_objective", self.file)
+        ifcopenshell.api.run("constraint.assign_constraint", self.file, product=element, constraint=constraint)
+        assert ifcopenshell.util.constraint.get_constrained_elements(constraint) == {element}