First Commit

2026-05-31 10:17:09 +07:00
commit 17a9c69379
4547 changed files with 1170384 additions and 0 deletions
@@ -0,0 +1,63 @@
+# 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/>.
+
+from datetime import datetime
+from typing import Optional
+
+import ifcopenshell.api.root
+import ifcopenshell.api.sequence
+
+
+def add_cost_schedule(
+    file: ifcopenshell.file, name: Optional[str] = None, predefined_type: str = "NOTDEFINED"
+) -> ifcopenshell.entity_instance:
+    """Add a new cost schedule
+
+    A cost schedule is a group of cost items which typically represent a
+    cost plan or breakdown of the project. This may be used as an estimate,
+    bid, or actual cost.
+
+    Alternatively, a cost schedule may also represent a schedule of rates,
+    which include cost items which capture unit rates for different elements
+    or processes.
+
+    As such, creating a cost schedule is necessary prior to creating and
+    managing any cost items.
+
+    :param name: The name of the cost schedule.
+    :param predefined_type: The predefined type of the cost schedule, chosen
+        from a valid type in the IFC documentation for
+        IfcCostScheduleTypeEnum
+    :return: The newly created IfcCostSchedule entity
+
+    Example:
+
+    .. code:: python
+
+        schedule = ifcopenshell.api.cost.add_cost_schedule(model)
+        # Now that we have a cost schedule, we may add cost items to it
+        item = ifcopenshell.api.cost.add_cost_item(model, cost_schedule=schedule)
+    """
+    cost_schedule = ifcopenshell.api.root.create_entity(
+        file,
+        ifc_class="IfcCostSchedule",
+        predefined_type=predefined_type,
+        name=name,
+    )
+    cost_schedule.UpdateDate = ifcopenshell.api.sequence.add_date_time(file, datetime.now())
+    return cost_schedule