mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-09 17:31:45 +00:00
Generate functions for all API usecases for better static code features. See #2693.
This commit is contained in:
Dion Moult
@@ -20,109 +20,99 @@ import ifcopenshell
|
||||
import ifcopenshell.api
|
||||
|
||||
|
||||
class Usecase:
|
||||
def __init__(self, file, relating_process=None, related_object=None):
|
||||
"""Assigns an object to be related to a process, typically a construction task
|
||||
def assign_process(file, relating_process=None, related_object=None) -> None:
|
||||
"""Assigns an object to be related to a process, typically a construction task
|
||||
|
||||
Processes work using the ICOM (Input, Controls, Outputs, Mechanisms)
|
||||
paradigm in IFC. This process model is commonly used in modeling
|
||||
manufacturing functions.
|
||||
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).
|
||||
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 |
|
||||
+-----------+
|
||||
+----------+
|
||||
| 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.
|
||||
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 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 controls, a cost item may be defined as a control to a task.
|
||||
|
||||
For resources, any construction resource may be assigned to a task.
|
||||
For resources, any construction resource may be assigned to a task.
|
||||
|
||||
:param relating_process: The IfcProcess (typically IfcTask) that the
|
||||
input, control, or resource is related to.
|
||||
:type relating_process: ifcopenshell.entity_instance
|
||||
:param related_object: The IfcProduct (for input), IfcCostItem (for
|
||||
control) or IfcConstructionResource (for resource).
|
||||
:type related_object: ifcopenshell.entity_instance
|
||||
:return: The newly created IfcRelAssignsToProcess relationship
|
||||
:rtype: ifcopenshell.entity_instance
|
||||
:param relating_process: The IfcProcess (typically IfcTask) that the
|
||||
input, control, or resource is related to.
|
||||
:type relating_process: ifcopenshell.entity_instance
|
||||
:param related_object: The IfcProduct (for input), IfcCostItem (for
|
||||
control) or IfcConstructionResource (for resource).
|
||||
:type related_object: ifcopenshell.entity_instance
|
||||
:return: The newly created IfcRelAssignsToProcess relationship
|
||||
:rtype: ifcopenshell.entity_instance
|
||||
|
||||
Example:
|
||||
Example:
|
||||
|
||||
.. code:: python
|
||||
.. code:: python
|
||||
|
||||
# Let's imagine we are creating a construction schedule. All tasks
|
||||
# need to be part of a work schedule.
|
||||
schedule = ifcopenshell.api.run("sequence.add_work_schedule", model, name="Construction Schedule A")
|
||||
# Let's imagine we are creating a construction schedule. All tasks
|
||||
# need to be part of a work schedule.
|
||||
schedule = ifcopenshell.api.run("sequence.add_work_schedule", model, name="Construction Schedule A")
|
||||
|
||||
# Let's create a construction task. Note that the predefined type is
|
||||
# important to distinguish types of tasks.
|
||||
task = ifcopenshell.api.run("sequence.add_task", model,
|
||||
work_schedule=schedule, name="Demolish existing", identification="A", predefined_type="DEMOLITION")
|
||||
# Let's create a construction task. Note that the predefined type is
|
||||
# important to distinguish types of tasks.
|
||||
task = ifcopenshell.api.run("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.run("root.create_entity", model, ifc_class="IfcWall")
|
||||
# Let's say we have a wall somewhere.
|
||||
wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
|
||||
|
||||
# Let's demolish that wall!
|
||||
ifcopenshell.api.run("sequence.assign_process", model, relating_process=task, related_object=wall)
|
||||
"""
|
||||
self.file = file
|
||||
self.settings = {
|
||||
"relating_process": relating_process,
|
||||
"related_object": related_object,
|
||||
}
|
||||
# Let's demolish that wall!
|
||||
ifcopenshell.api.run("sequence.assign_process", model, relating_process=task, related_object=wall)
|
||||
"""
|
||||
settings = {
|
||||
"relating_process": relating_process,
|
||||
"related_object": related_object,
|
||||
}
|
||||
|
||||
def execute(self):
|
||||
if self.settings["related_object"].HasAssignments:
|
||||
for assignment in self.settings["related_object"].HasAssignments:
|
||||
if (
|
||||
assignment.is_a("IfcRelAssignsToProcess")
|
||||
and assignment.RelatingProcess == self.settings["relating_process"]
|
||||
):
|
||||
return
|
||||
if settings["related_object"].HasAssignments:
|
||||
for assignment in settings["related_object"].HasAssignments:
|
||||
if assignment.is_a("IfcRelAssignsToProcess") and assignment.RelatingProcess == settings["relating_process"]:
|
||||
return
|
||||
|
||||
operates_on = None
|
||||
if self.settings["relating_process"].OperatesOn:
|
||||
operates_on = self.settings["relating_process"].OperatesOn[0]
|
||||
operates_on = None
|
||||
if settings["relating_process"].OperatesOn:
|
||||
operates_on = settings["relating_process"].OperatesOn[0]
|
||||
|
||||
if operates_on:
|
||||
related_objects = list(operates_on.RelatedObjects)
|
||||
related_objects.append(self.settings["related_object"])
|
||||
operates_on.RelatedObjects = related_objects
|
||||
ifcopenshell.api.run(
|
||||
"owner.update_owner_history", self.file, **{"element": operates_on}
|
||||
)
|
||||
else:
|
||||
operates_on = self.file.create_entity(
|
||||
"IfcRelAssignsToProcess",
|
||||
**{
|
||||
"GlobalId": ifcopenshell.guid.new(),
|
||||
"OwnerHistory": ifcopenshell.api.run(
|
||||
"owner.create_owner_history", self.file
|
||||
),
|
||||
"RelatedObjects": [self.settings["related_object"]],
|
||||
"RelatingProcess": self.settings["relating_process"],
|
||||
}
|
||||
)
|
||||
return operates_on
|
||||
if operates_on:
|
||||
related_objects = list(operates_on.RelatedObjects)
|
||||
related_objects.append(settings["related_object"])
|
||||
operates_on.RelatedObjects = related_objects
|
||||
ifcopenshell.api.run("owner.update_owner_history", file, **{"element": operates_on})
|
||||
else:
|
||||
operates_on = file.create_entity(
|
||||
"IfcRelAssignsToProcess",
|
||||
**{
|
||||
"GlobalId": ifcopenshell.guid.new(),
|
||||
"OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", file),
|
||||
"RelatedObjects": [settings["related_object"]],
|
||||
"RelatingProcess": settings["relating_process"],
|
||||
}
|
||||
)
|
||||
return operates_on
|
||||
|
||||
Reference in New Issue
Block a user