mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-09 09:21:46 +00:00
Andrej730
8cfd6b1754
As this information is already provided in type hints and we don't need to maintain it in two places.
120 lines
4.9 KiB
Python
120 lines
4.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.api.root
|
|
import ifcopenshell.api.project
|
|
import ifcopenshell.api.aggregate
|
|
import ifcopenshell.api.owner.settings
|
|
import ifcopenshell.util.date
|
|
from datetime import time
|
|
from datetime import datetime
|
|
from typing import Union, Optional
|
|
|
|
|
|
def add_work_schedule(
|
|
file: ifcopenshell.file,
|
|
name: str = "Unnamed",
|
|
predefined_type: str = "NOTDEFINED",
|
|
object_type=None,
|
|
start_time: Optional[Union[str, time]] = None,
|
|
work_plan: Optional[ifcopenshell.entity_instance] = None,
|
|
) -> ifcopenshell.entity_instance:
|
|
"""Add a new work schedule
|
|
|
|
A work schedule is a group of tasks, where the tasks are typically
|
|
either for maintenance or for construction scheduling.
|
|
|
|
:param name: The name of the work schedule.
|
|
:param predefined_type: The type of schedule, chosen from ACTUAL,
|
|
BASELINE, and PLANNED. Typically you would start with PLANNED, then
|
|
convert to a BASELINE when changes are made with separate schedules,
|
|
then have a parallel ACTUAL schedule.
|
|
:param start_time: The earlier start time when the schedule is relevant.
|
|
May be represented with an ISO standard string.
|
|
:param work_plan: The IfcWorkPlan the schedule will be part of. If not
|
|
provided, the schedule will not be grouped in a work plan and would
|
|
exist as a top level schedule in the project. This is not
|
|
recommended.
|
|
:return: The newly created IfcWorkSchedule
|
|
|
|
Example:
|
|
|
|
.. code:: python
|
|
|
|
# This will hold all our construction schedules
|
|
work_plan = ifcopenshell.api.sequence.add_work_plan(model, name="Construction")
|
|
|
|
# Let's imagine this is one of our schedules in our work plan.
|
|
schedule = ifcopenshell.api.sequence.add_work_schedule(model,
|
|
name="Construction Schedule A", work_plan=work_plan)
|
|
|
|
# Add a root task to represent the design milestones, and major
|
|
# project phases.
|
|
ifcopenshell.api.sequence.add_task(model,
|
|
work_schedule=schedule, name="Milestones", identification="A")
|
|
ifcopenshell.api.sequence.add_task(model,
|
|
work_schedule=schedule, name="Design", identification="B")
|
|
construction = ifcopenshell.api.sequence.add_task(model,
|
|
work_schedule=schedule, name="Construction", identification="C")
|
|
"""
|
|
start_time = start_time or datetime.now()
|
|
work_schedule = ifcopenshell.api.root.create_entity(
|
|
file,
|
|
ifc_class="IfcWorkSchedule",
|
|
predefined_type=predefined_type,
|
|
name=name,
|
|
)
|
|
if file.schema == "IFC2X3":
|
|
work_schedule.CreationDate = createIfcDateAndTime(file, datetime.now())
|
|
else:
|
|
work_schedule.CreationDate = ifcopenshell.util.date.datetime2ifc(datetime.now(), "IfcDateTime")
|
|
user = ifcopenshell.api.owner.settings.get_user(file)
|
|
if user:
|
|
work_schedule.Creators = [user.ThePerson]
|
|
if file.schema == "IFC2X3":
|
|
work_schedule.StartTime = createIfcDateAndTime(file, start_time)
|
|
else:
|
|
work_schedule.StartTime = ifcopenshell.util.date.datetime2ifc(start_time, "IfcDateTime")
|
|
if object_type:
|
|
work_schedule.ObjectType = object_type
|
|
if work_plan:
|
|
ifcopenshell.api.aggregate.assign_object(
|
|
file,
|
|
products=[work_schedule],
|
|
relating_object=work_plan,
|
|
)
|
|
elif file.schema != "IFC2X3":
|
|
# 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
|
|
context = file.by_type("IfcContext")[0]
|
|
ifcopenshell.api.project.assign_declaration(
|
|
file,
|
|
definitions=[work_schedule],
|
|
relating_context=context,
|
|
)
|
|
return work_schedule
|
|
|
|
|
|
def createIfcDateAndTime(file: ifcopenshell.file, dt: datetime):
|
|
ifc_dt = file.create_entity("IfcDateAndTime")
|
|
ifc_dt.DateComponent = file.create_entity(
|
|
"IfcCalendarDate", **ifcopenshell.util.date.datetime2ifc(dt, "IfcCalendarDate")
|
|
)
|
|
ifc_dt.TimeComponent = file.create_entity("IfcLocalTime", **ifcopenshell.util.date.datetime2ifc(dt, "IfcLocalTime"))
|
|
return ifc_dt
|