First Commit

2026-05-31 10:17:09 +07:00
commit 17a9c69379
4547 changed files with 1170384 additions and 0 deletions
@@ -0,0 +1,118 @@
+# 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.util.sequence
+
+
+def assign_recurrence_pattern(
+    file: ifcopenshell.file,
+    parent: ifcopenshell.entity_instance,
+    recurrence_type: ifcopenshell.util.sequence.RECURRENCE_TYPE = "WEEKLY",
+) -> ifcopenshell.entity_instance:
+    """Define a time to recur at a particular interval
+
+    There are two scenarios where you might want to define a recurring time
+    pattern.
+
+    You might want a task to be scheduled at a recurring interval,
+    this is common for maintenance tasks which need to be performed monthly,
+    every 6 months, every year, etc.
+
+    Alternatively, you might be defining a work calendar, which defines
+    working days or holidays. The working days might be every week from
+    monday to friday ("every" week means it recurs every week), or the
+    holidays might be the same every year.
+
+    The types of recurrence are:
+
+    - DAILY: every Nth (interval) day for up to X (Occurrences) occurrences.
+        e.g. Every day, every 2 days, every day up to 5 times, etc
+    - WEEKLY: every Nth (interval) MTWTFSS (WeekdayComponent) for up to X
+        (Occurrences) occurrences. e.g. Every Monday, every weekday, every
+        other saturday, etc
+    - MONTHLY_BY_DAY_OF_MONTH: every Nth (DayComponent) of every Xth
+        (Interval) Month up to Y (Occurrences) occurrences. e.g. Every 15th of
+        the Month.
+    - MONTHLY_BY_POSITION: Every Nth (Position) MTWTFSS (WeekdayComponent)
+        of every Xth (Interval) Month up to Y (Occurrences) occurrences. e.g.
+        Every second Tuesday of the Month.
+    - YEARLY_BY_DAY_OF_MONTH: every Nth (DayComponent) of every JFMAMJJASOND
+        (MonthComponent) month of every Yth (Interval) Year up to Z
+        (Occurrences) occurrences. e.g. every 25th of December.
+    - YEARLY_BY_POSITION: every Nth (Position) MTWTFSS (WeekdayComponent) of
+        every JFMAMJJASOND (MonthComponent) month of every Yth (Interval)
+        Year up to Z (Occurrences) occurrences. e.g. every third Wednesday
+        of January.
+
+    These recurrence patterns are fairly standard in all calendar and
+    scheduling applications.
+
+    :param parent: Either an IfcTaskTimeRecurring if you are defining a
+        recurring schedule for a task, or IfcWorkTime if you are defining a
+        recurring pattern for a workdays or holidays in a calendar.
+    :param recurrence_type: One of the types of recurrences.
+    :return: The newly created IfcRecurrencePattern
+
+    Example:
+
+    .. code:: python
+
+        # Let's create a new calendar.
+        calendar = ifcopenshell.api.sequence.add_work_calendar(model)
+
+        # Let's start defining the times that we work during the week.
+        work_time = ifcopenshell.api.sequence.add_work_time(model,
+            work_calendar=calendar, time_type="WorkingTimes")
+
+        # We create a weekly recurrence
+        pattern = ifcopenshell.api.sequence.assign_recurrence_pattern(model,
+            parent=work_time, recurrence_type="WEEKLY")
+
+        # State that we work from weekdays 1 to 5 (i.e. Monday to Friday)
+        ifcopenshell.api.sequence.edit_recurrence_pattern(model,
+            recurrence_pattern=pattern, attributes={"WeekdayComponent": [1, 2, 3, 4, 5]})
+
+        # Let's imagine we are creating a maintenance schedule.
+        schedule = ifcopenshell.api.sequence.add_work_schedule(model, name="Equipment Maintenance")
+
+        # Now let's imagine we have a task to maintain the chillers
+        task = ifcopenshell.api.sequence.add_task(model,
+            work_schedule=schedule, name="Chiller maintenance")
+
+        # Because it is a maintenance task, we must schedule a recurring time
+        time = ifcopenshell.api.sequence.add_task_time(model, task=task, is_recurring=True)
+
+        # We create a monthly recurrence
+        pattern = ifcopenshell.api.sequence.assign_recurrence_pattern(model,
+            parent=work_time, recurrence_type="MONTHLY_BY_DAY_OF_MONTH")
+
+        # Specifically, the maintenance task must occur every 6 months
+        ifcopenshell.api.sequence.edit_recurrence_pattern(model,
+            recurrence_pattern=pattern, attributes={"DayComponent": [1], "Interval": 6})
+    """
+    recurrence = file.create_entity("IfcRecurrencePattern", recurrence_type)
+
+    if parent.is_a("IfcWorkTime"):
+        if (old_recurrence := parent.RecurrencePattern) and file.get_total_inverses(old_recurrence) == 1:
+            file.remove(old_recurrence)
+        parent.RecurrencePattern = recurrence
+    elif parent.is_a("IfcTaskTimeRecurring"):
+        if (recurrence_old := parent.Recurrence) and file.get_total_inverses(recurrence_old) == 1:
+            file.remove(recurrence_old)
+        parent.Recurrence = recurrence
+    return recurrence