First Commit

2026-05-31 10:17:09 +07:00
commit 17a9c69379
4547 changed files with 1170384 additions and 0 deletions
@@ -0,0 +1,99 @@
+# 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 ifcopenshell
+import ifcopenshell.api.owner
+import ifcopenshell.guid
+
+
+def assign_actor(
+    file: ifcopenshell.file, relating_actor: ifcopenshell.entity_instance, related_object: ifcopenshell.entity_instance
+) -> ifcopenshell.entity_instance:
+    """Assigns an actor to an object
+
+    An actor may be assigned to objects which implies that the actor is
+    responsible for. This is most commonly used in facility management for
+    indicating the manufacturers, suppliers, and warrantors for product
+    types.
+
+    Here are a list of objects you may assign an actor to:
+
+    * IfcControl: Indicates project directives issued by the actor.
+    * IfcGroup: Indicates groups for which the actor is responsible.
+    * IfcProduct: Indicates products for which the actor is responsible.
+    * IfcProcess: Indicates processes for which the actor is responsible.
+    * IfcResource: Indicates resources for which the actor is responsible to
+        allocate, manage, or delegate. This is not the actor actually using
+        the resource or performing the work. For that type of actor, see
+        ifcopenshell.api.resource.assign_resource.
+
+    :param relating_actor: The IfcActor who is responsible for the object.
+    :param related_object: The object the actor is responsible for.
+    :return: The newly created IfcRelAssignsToActor relationship.
+
+    Example:
+
+    .. code:: python
+
+        # We need to procure and install 2 of this particular pump type in our facility.
+        pump_type = ifcopenshell.api.root.create_entity(model, ifc_class="IfcPumpType")
+
+        # Define who the manufacturer is
+        manufacturer = ifcopenshell.api.owner.add_organisation(model,
+            identification="PWP", name="Pumps With Power")
+        ifcopenshell.api.owner.add_role(model, assigned_object=manufacturer, role="MANUFACTURER")
+
+        # To help our facility manager, it's nice to provide contact details
+        # of the manufacturer so they know how to call when the pump breaks.
+        telecom = ifcopenshell.api.owner.add_address(model,
+            assigned_object=organisation, ifc_class="IfcTelecomAddress")
+        ifcopenshell.api.owner.edit_address(model, address=telecom,
+            attributes={"Purpose": "OFFICE", "TelephoneNumbers": ["+61432466949"],
+            "ElectronicMailAddresses": ["contact@example.com"],
+            "WWWHomePageURL": "https://example.com"})
+
+        # Make the manufacturer responsible for that pump type.
+        ifcopenshell.api.owner.assign_actor(model,
+            relating_actor=manufacturer, related_object=pump_type)
+    """
+    if related_object.HasAssignments:
+        for rel in related_object.HasAssignments:
+            if rel.is_a("IfcRelAssignsToActor") and rel.RelatingActor == relating_actor:
+                return rel
+
+    rel = None
+
+    if relating_actor.IsActingUpon:
+        rel = relating_actor.IsActingUpon[0]
+
+    if rel:
+        related_objects = list(rel.RelatedObjects)
+        related_objects.append(related_object)
+        rel.RelatedObjects = related_objects
+        ifcopenshell.api.owner.update_owner_history(file, element=rel)
+    else:
+        rel = file.create_entity(
+            "IfcRelAssignsToActor",
+            **{
+                "GlobalId": ifcopenshell.guid.new(),
+                "OwnerHistory": ifcopenshell.api.owner.create_owner_history(file),
+                "RelatedObjects": [related_object],
+                "RelatingActor": relating_actor,
+            }
+        )
+    return rel