First Commit

2026-05-31 10:17:09 +07:00
commit 17a9c69379
4547 changed files with 1170384 additions and 0 deletions
@@ -0,0 +1,111 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2023 Dion Moult, Yassine Oualid <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 Union
+
+import ifcopenshell
+
+
+def get_constraints(product: ifcopenshell.entity_instance) -> list[ifcopenshell.entity_instance]:
+    """
+    Retrieves the constraints assigned to the `product`.
+
+    :param product: The IFC element.
+    :return: List of assigned constraints.
+    """
+    constraints = []
+    for rel in product.HasAssociations or []:
+        if rel.is_a("IfcRelAssociatesConstraint"):
+            constraints.append(rel.RelatingConstraint)
+    return constraints
+
+
+def get_constrained_elements(constraint: ifcopenshell.entity_instance) -> set[ifcopenshell.entity_instance]:
+    """
+    Retrieves the elements constrained by a `constraint`.
+
+    :param product: The IFC element.
+    :return: Set of elements constrained by a `constrant`.
+    """
+    elements = set()
+    for rel in constraint.file.get_inverse(constraint):
+        if rel.is_a("IfcRelAssociatesConstraint"):
+            elements.update(rel.RelatedObjects)
+    return elements
+
+
+def get_metrics(constraint: ifcopenshell.entity_instance) -> list[ifcopenshell.entity_instance]:
+    """
+    Retrieves the list of nested constraints for a IfcObjective `constraint`.
+
+    :param product: IfcObjective constraint.
+    :return: List of nested constraints.
+    """
+
+    metrics = []
+    for metric in constraint.BenchmarkValues or []:
+        metrics.append(metric)
+    return metrics
+
+
+def get_metric_reference(metric: ifcopenshell.entity_instance, is_deep=True):
+    def get_reference_Attribute(ref, path):
+        if ref:
+            if is_deep:
+                if not path:
+                    path = ref.AttributeIdentifier
+                else:
+                    path += ".{}".format(ref.AttributeIdentifier) if ref.AttributeIdentifier else ""
+                return get_reference_Attribute(ref.InnerReference, path)
+            else:
+                return ref.AttributeIdentifier
+        return path
+
+    reference = metric.ReferencePath
+    return get_reference_Attribute(reference, "")
+
+
+def get_metric_constraints(
+    resource: ifcopenshell.entity_instance, attribute
+) -> Union[list[ifcopenshell.entity_instance], None]:
+    metrics = []
+    for constraint in get_constraints(resource) or []:
+        for metric in get_metrics(constraint) or []:
+            if bool(
+                get_metric_reference(metric, is_deep=False) == attribute
+                or get_metric_reference(metric, is_deep=True) == attribute
+            ):
+                metrics.append(metric)
+    if metrics:
+        return metrics
+    return None
+
+
+def is_hard_constraint(metric: ifcopenshell.entity_instance) -> bool:
+    return metric.ConstraintGrade == "HARD" and metric.Benchmark == "EQUALTO"
+
+
+def is_attribute_locked(product: ifcopenshell.entity_instance, attribute) -> bool:
+    is_locked = False
+    metrics = get_metric_constraints(product, attribute)
+    for metric in metrics or []:
+        if is_hard_constraint(metric):
+            is_locked = True
+    return is_locked