First Commit

2026-05-31 10:17:09 +07:00
commit 17a9c69379
4547 changed files with 1170384 additions and 0 deletions
@@ -0,0 +1,130 @@
+# 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_process(
+    file: ifcopenshell.file,
+    relating_process: ifcopenshell.entity_instance,
+    related_object: ifcopenshell.entity_instance,
+) -> ifcopenshell.entity_instance:
+    """Assigns an object as an input, control, or resource of a process
+
+    Processes work using the ICOM (Input, Controls, Outputs, Mechanisms)
+    paradigm in IFC. This process model is commonly used in modeling
+    manufacturing functions.
+
+    For example, processes (such as tasks) consume Inputs and transform them
+    into Outputs. The process may only occur within the limits of Controls
+    (e.g. cost items) and may require Mechanisms (ISO9000 calls them
+    Mechanisms, whereas IFC calls them resources, such as raw materials,
+    labour, or equipment).
+
+                  +----------+
+                  | Controls |
+                  +----------+
+                        |
+                        V
+    +--------+     +---------+     +---------+
+    | Inputs | --> | Process | --> | Outputs |
+    +--------+     +---------+     +---------+
+                        ^
+                        |
+                  +-----------+
+                  | Resources |
+                  +-----------+
+
+    There are three main scenarios where an object may be related to a
+    task: defining inputs, controls, and resources of a process.
+
+    For inputs, a product (i.e. wall) may be defined as an input to a task,
+    such as when the task is to demolish the wall (i.e. the wall is an
+    input, and there is no output).
+
+    For controls, a cost item may be defined as a control to a task.
+
+    For resources, any construction resource may be assigned to a task.
+
+    .. warning::
+
+        This function creates an **Input** relationship
+        (``IfcRelAssignsToProcess``), meaning the product is *consumed* or
+        *operated on* by the task — the typical case is demolition or
+        maintenance.
+
+        If the task *constructs or installs* a product (e.g. erecting a wall
+        or fitting a window), use :func:`assign_product` instead, which
+        creates an **Output** relationship (``IfcRelAssignsToProduct``).
+
+    :param relating_process: The IfcProcess (typically IfcTask) that the
+        input, control, or resource is related to.
+    :param related_object: The IfcProduct (for input), IfcCostItem (for
+        control) or IfcConstructionResource (for resource).
+    :return: The newly created IfcRelAssignsToProcess relationship
+
+    Example:
+
+    .. code:: python
+
+        # Let's imagine we are creating a construction schedule. All tasks
+        # need to be part of a work schedule.
+        schedule = ifcopenshell.api.sequence.add_work_schedule(model, name="Construction Schedule A")
+
+        # Let's create a demolition task. Note that the predefined type is
+        # important to distinguish types of tasks.
+        task = ifcopenshell.api.sequence.add_task(model,
+            work_schedule=schedule, name="Demolish existing", identification="A", predefined_type="DEMOLITION")
+
+        # Let's say we have a wall somewhere.
+        wall = ifcopenshell.api.root.create_entity(model, ifc_class="IfcWall")
+
+        # The wall is an INPUT to the demolition task (it will be consumed).
+        ifcopenshell.api.sequence.assign_process(model, relating_process=task, related_object=wall)
+
+        # For a construction task that BUILDS a wall, use assign_product instead:
+        # build_task = ifcopenshell.api.sequence.add_task(model, ..., predefined_type="CONSTRUCTION")
+        # ifcopenshell.api.sequence.assign_product(model, relating_product=wall, related_object=build_task)
+    """
+    if related_object.HasAssignments:
+        for assignment in related_object.HasAssignments:
+            if assignment.is_a("IfcRelAssignsToProcess") and assignment.RelatingProcess == relating_process:
+                return
+
+    operates_on = None
+    if relating_process.OperatesOn:
+        operates_on = relating_process.OperatesOn[0]
+
+    if operates_on:
+        related_objects = list(operates_on.RelatedObjects)
+        related_objects.append(related_object)
+        operates_on.RelatedObjects = related_objects
+        ifcopenshell.api.owner.update_owner_history(file, element=operates_on)
+    else:
+        operates_on = file.create_entity(
+            "IfcRelAssignsToProcess",
+            **{
+                "GlobalId": ifcopenshell.guid.new(),
+                "OwnerHistory": ifcopenshell.api.owner.create_owner_history(file),
+                "RelatedObjects": [related_object],
+                "RelatingProcess": relating_process,
+            }
+        )
+    return operates_on