Files
IfcOpenShell/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_plan.py
T
Andrej730 0e8810c1f5 typing
2025-03-14 18:19:02 +05:00

58 lines
1.9 KiB
Python

# 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.project
import ifcopenshell.api.aggregate
import ifcopenshell.util.element
def remove_work_plan(file: ifcopenshell.file, work_plan: ifcopenshell.entity_instance) -> None:
"""Removes a work plan
Note that schedules that are grouped under the work plan are not
removed.
:param work_plan: The IfcWorkPlan to remove.
:return: None
Example:
.. code:: python
# This will hold all our construction schedules
work_plan = ifcopenshell.api.sequence.add_work_plan(model, name="Construction")
# And remove it immediately
ifcopenshell.api.sequence.remove_work_plan(model, work_plan=work_plan)
"""
ifcopenshell.api.project.unassign_declaration(
file,
definitions=[work_plan],
relating_context=file.by_type("IfcContext")[0],
)
related_objects = [obj for rel in work_plan.IsDecomposedBy for obj in rel.RelatedObjects]
if related_objects:
ifcopenshell.api.aggregate.unassign_object(file, related_objects)
history = work_plan.OwnerHistory
file.remove(work_plan)
if history:
ifcopenshell.util.element.remove_deep2(file, history)