Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-08-12 10:33:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Generate functions for all API usecases for better static code features. See #2693.

Browse Source
This commit is contained in:
Dion Moult
2024-05-06 14:35:39 +10:00
parent 10f894e2ea
commit d11ec67129
330 changed files with 13283 additions and 13751 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ifcopenshell-python/ifcopenshell/api/sequence/assign_workplan.py
+38 -41
View File
@@ -20,52 +20,49 @@ import ifcopenshell
import ifcopenshell.api
class Usecase:
def __init__(self, file, work_schedule=None, work_plan=None):
"""Assigns a work schedule to a work plan
def assign_workplan(file, work_schedule=None, work_plan=None) -> None:
"""Assigns a work schedule to a work plan
Typically, work schedules would be assigned to a work plan at creation.
However you may also delay this and do it manually afterwards.
Typically, work schedules would be assigned to a work plan at creation.
However you may also delay this and do it manually afterwards.
:param work_schedule: The IfcWorkSchedule that will be assigned to the
work plan.
:type work_schedule: ifcopenshell.entity_instance
:param work_plan: The IfcWorkPlan for the schedule to be assigned to.
:type work_plan: ifcopenshell.entity_instance
:return: The IfcRelAggregates relationship
:rtype: ifcopenshell.entity_instance
:param work_schedule: The IfcWorkSchedule that will be assigned to the
work plan.
:type work_schedule: ifcopenshell.entity_instance
:param work_plan: The IfcWorkPlan for the schedule to be assigned to.
:type work_plan: ifcopenshell.entity_instance
:return: The IfcRelAggregates relationship
:rtype: ifcopenshell.entity_instance
Example:
Example:
.. code:: python
.. code:: python
# This will hold all our construction schedules
work_plan = ifcopenshell.api.run("sequence.add_work_plan", model, name="Construction")
# This will hold all our construction schedules
work_plan = ifcopenshell.api.run("sequence.add_work_plan", model, name="Construction")
# Alternatively, if you create a schedule without a work plan ...
schedule = ifcopenshell.api.run("sequence.add_work_schedule", model, name="Construction Schedule A")
# Alternatively, if you create a schedule without a work plan ...
schedule = ifcopenshell.api.run("sequence.add_work_schedule", model, name="Construction Schedule A")
# ... you can assign the work plan afterwards.
ifcopenshell.api.run("sequence.assign_workplan", work_schedule=schedule, work_plan=work_plan)
"""
self.file = file
self.settings = {"work_schedule": work_schedule, "work_plan": work_plan}
# ... you can assign the work plan afterwards.
ifcopenshell.api.run("sequence.assign_workplan", work_schedule=schedule, work_plan=work_plan)
"""
settings = {"work_schedule": work_schedule, "work_plan": work_plan}
def execute(self):
# TODO: this is an ambiguity by buildingSMART
# See https://forums.buildingsmart.org/t/is-the-ifcworkschedule-project-declaration-mutually-exclusive-to-aggregation-within-a-relating-ifcworkplan/3510
ifcopenshell.api.run(
"project.unassign_declaration",
self.file,
definitions=[self.settings["work_schedule"]],
relating_context=self.file.by_type("IfcContext")[0],
)
rel_aggregates = ifcopenshell.api.run(
"aggregate.assign_object",
self.file,
**{
"products": [self.settings["work_schedule"]],
"relating_object": self.settings["work_plan"],
}
)
return rel_aggregates
# TODO: this is an ambiguity by buildingSMART
# See https://forums.buildingsmart.org/t/is-the-ifcworkschedule-project-declaration-mutually-exclusive-to-aggregation-within-a-relating-ifcworkplan/3510
ifcopenshell.api.run(
"project.unassign_declaration",
file,
definitions=[settings["work_schedule"]],
relating_context=file.by_type("IfcContext")[0],
)
rel_aggregates = ifcopenshell.api.run(
"aggregate.assign_object",
file,
**{
"products": [settings["work_schedule"]],
"relating_object": settings["work_plan"],
}
)
return rel_aggregates