New assign / unassign declaration usecase, minor code & formatting cleanup

2026-08-10 01:41:57 +00:00 · 2021-04-07 13:15:16 +10:00
parent 13d4a99358
commit ae0789e4ec
25 changed files with 289 additions and 228 deletions
@@ -1,17 +1,10 @@
 import ifcopenshell.api
-import ifcopenshell.util.date
-from datetime import datetime, timedelta


 class Usecase:
    def __init__(self, file, **settings):
        self.file = file
-        self.settings = {
-            "name": "Unnamed", 
-            "predefined_type": "NOTDEFINED", 
-            "working_times":[], 
-            "exception_times":[]
-        }
+        self.settings = {"name": "Unnamed", "predefined_type": "NOTDEFINED", "working_times": [], "exception_times": []}
        for key, value in settings.items():
            self.settings[key] = value

@@ -23,26 +16,8 @@ class Usecase:
            predefined_type=self.settings["predefined_type"],
            name=self.settings["name"],
        )
-        working_time = self.file.create_entity("IfcWorkTime", **{"Name":"DefaultWorkingTime"})
-        self.settings["working_times"].append(working_time)
-        work_calendar.WorkingTimes = self.settings["working_times"]
-
-        exception_time = self.file.create_entity("IfcWorkTime", **{"Name":"DefaultExceptionTime"})
-        self.settings["exception_times"].append(exception_time)
-        work_calendar.ExceptionTimes = self.settings["exception_times"]
-
        context = self.file.by_type("IfcContext")[0]
-        if context.Declares:
-            rel_declares = context.Declares[0]
-            ifcopenshell.api.run("owner.update_owner_history", self.file, element=rel_declares)
-        else:
-            rel_declares = self.file.create_entity("IfcRelDeclares", **{
-                "GlobalId": ifcopenshell.guid.new(),
-                "OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", self.file),
-                "RelatingContext": context
-            })
-        related_definitions = list(rel_declares.RelatedDefinitions or [])
-        related_definitions.append(work_calendar)
-        rel_declares.RelatedDefinitions = related_definitions
-
-        return work_calendar
+        ifcopenshell.api.run(
+            "project.assign_declaration", self.file, definition=work_calendar, relating_context=context
+        )
+        return work_calendar
@@ -1,37 +0,0 @@
-import ifcopenshell
-import ifcopenshell.api
-import ifcopenshell.util.date
-from datetime import datetime, timedelta
-
-
-class Usecase:
-    def __init__(self, file, **settings):
-        self.file = file
-        self.settings = {
-            "object": None,
-            "name":None,
-            "recurrence_pattern": None,
-            "start": datetime.now(),
-            "finish": datetime.now() + timedelta(days=365)
-        }
-        for key, value in settings.items():
-            self.settings[key] = value
-
-    def execute(self):
-        working_time = self.file.create_entity("IfcWorkTime", **{
-            "Name": self.settings["name"],
-            "Start": ifcopenshell.util.date.datetime2ifc(self.settings["start"], "IfcTime"),
-            "Finish": ifcopenshell.util.date.datetime2ifc(self.settings["finish"], "IfcTime")
-        })
-
-        #TODO Implement user settings for recurrence pattern
-        working_time.RecurrencePattern = ifcopenshell.api.run("time.add_recurrence_pattern", self.file)
-
-        if self.settings["object"].is_a('IfcWorkCalendar'):
-            if self.settings["object"].WorkingTimes:
-                working_times = list(self.settings["object"].WorkingTimes)
-                working_times.append(working_time)
-                self.settings["object"].WorkingTimes = working_times
-            else:
-                self.settings["object"].WorkingTimes = [working_time]
-        return working_time
@@ -25,18 +25,7 @@ class Usecase:
        work_plan.StartTime = ifcopenshell.util.date.datetime2ifc(self.settings["start_time"], "IfcDateTime")

        context = self.file.by_type("IfcContext")[0]
-        if context.Declares:
-            rel_declares = context.Declares[0]
-            ifcopenshell.api.run("owner.update_owner_history", self.file, element=rel_declares)
-        else:
-            rel_declares = self.file.create_entity("IfcRelDeclares", **{
-                "GlobalId": ifcopenshell.guid.new(),
-                "OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", self.file),
-                "RelatingContext": context
-            })
-
-        related_definitions = list(rel_declares.RelatedDefinitions or [])
-        related_definitions.append(work_plan)
-        rel_declares.RelatedDefinitions = related_definitions
-
+        ifcopenshell.api.run(
+            "project.assign_declaration", self.file, definition=work_plan, relating_context=context
+        )
        return work_plan
@@ -6,7 +6,12 @@ from datetime import datetime
 class Usecase:
    def __init__(self, file, **settings):
        self.file = file
-        self.settings = {"name": "Unnamed", "predefined_type": "NOTDEFINED", "start_time": datetime.now(), "work_plan":None}
+        self.settings = {
+            "name": "Unnamed",
+            "predefined_type": "NOTDEFINED",
+            "start_time": datetime.now(),
+            "work_plan": None,
+        }
        for key, value in settings.items():
            self.settings[key] = value

@@ -23,25 +28,18 @@ class Usecase:
        if person:
            work_schedule.Creators = [person]
        work_schedule.StartTime = ifcopenshell.util.date.datetime2ifc(self.settings["start_time"], "IfcDateTime")
-        
-        if self.settings["work_plan"]:
-            rel_aggregates = ifcopenshell.api.run("aggregate.assign_object", self.file, **{
-                "product": work_schedule,
-                "relating_object": self.settings["work_plan"]
-            })
-        else:
-            context = self.file.by_type("IfcContext")[0]
-            if context.Declares:
-                rel_declares = context.Declares[0]
-                ifcopenshell.api.run("owner.update_owner_history", self.file, element=rel_declares)
-            else:
-                rel_declares = self.file.create_entity("IfcRelDeclares", **{
-                    "GlobalId": ifcopenshell.guid.new(),
-                    "OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", self.file),
-                    "RelatingContext": context
-                })
-            related_definitions = list(rel_declares.RelatedDefinitions or [])
-            related_definitions.append(work_schedule)
-            rel_declares.RelatedDefinitions = related_definitions

-        return work_schedule
+        if self.settings["work_plan"]:
+            ifcopenshell.api.run(
+                "aggregate.assign_object",
+                self.file,
+                **{"product": work_schedule, "relating_object": self.settings["work_plan"]}
+            )
+        else:
+            # 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 = self.file.by_type("IfcContext")[0]
+            ifcopenshell.api.run(
+                "project.assign_declaration", self.file, definition=work_schedule, relating_context=context
+            )
+        return work_schedule
@@ -0,0 +1,18 @@
+class Usecase:
+    def __init__(self, file, **settings):
+        self.file = file
+        self.settings = {"work_calendar": None, "type": "WorkingTimes", "name": None}
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        work_time = self.file.create_entity("IfcWorkTime", **{"Name": self.settings["name"]})
+        if self.settings["type"] == "WorkingTimes":
+            working_times = list(self.settings["work_calendar"].WorkingTimes or [])
+            working_times.append(work_time)
+            self.settings["work_calendar"].WorkingTimes = working_times
+        elif self.settings["type"] == "ExceptionTimes":
+            exception_times = list(self.settings["work_calendar"].ExceptionTimes or [])
+            exception_times.append(work_time)
+            self.settings["work_calendar"].WorkingTimes = exception_times
+        return work_time
@@ -1,31 +1,26 @@
 import ifcopenshell
 import ifcopenshell.api

+
 class Usecase:
    def __init__(self, file, **settings):
        self.file = file
-        self.settings = {
-            "work_schedule": None,
-            "work_plan":None,
-        }
+        self.settings = {"work_schedule": None, "work_plan": None}
        for key, value in settings.items():
            self.settings[key] = value

    def execute(self):
-        ###Project declaration should be removed if the workschedule is assigned to a project.####
-        if self.settings["work_schedule"].HasContext:
-            rel_declares = self.settings["work_schedule"].HasContext[0]
-            related_definitions = list(rel_declares.RelatedDefinitions)
-            related_definitions.remove(self.settings["work_schedule"])
-            rel_declares.RelatedDefinitions = related_definitions
-        if self.settings["work_plan"].IsDecomposedBy:
-            rel_aggregates = self.settings["work_plan"].IsDecomposedBy[0]
-            related_objects = list(rel_aggregates.RelatedObjects or [])
-            related_objects.append(self.settings["work_schedule"])
-            rel_aggregates.RelatedObjects = related_objects
-        else:             
-            rel_aggregates = ifcopenshell.api.run("aggregate.assign_object", self.file, **{
-                "product": 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",
+            self.file,
+            definition=self.settings["work_schedule"],
+            relating_context=self.file.by_type("IfcContext")[0],
+        )
+        rel_aggregates = ifcopenshell.api.run(
+            "aggregate.assign_object",
+            self.file,
+            **{"product": self.settings["work_schedule"], "relating_object": self.settings["work_plan"]}
+        )
+        return rel_aggregates
@@ -1,5 +1,6 @@
 import ifcopenshell.util.date

+
 class Data:
    is_loaded = False
    work_plans = {}
@@ -23,7 +24,7 @@ class Data:
        cls.load_work_schedules()
        cls.load_work_calendars()
        cls.load_tasks()
-        cls.is_loaded=True
+        cls.is_loaded = True

    @classmethod
    def load_work_plans(cls):
@@ -33,10 +34,10 @@ class Data:
            del data["OwnerHistory"]
            if data["Creators"]:
                data["Creators"] = [p.id() for p in data["Creators"]]
-            data["CreationDate"] = ifcopenshell.util.date.ifc2datetime(data["CreationDate"]).isoformat()
-            data["StartTime"] = ifcopenshell.util.date.ifc2datetime(data["StartTime"]).isoformat()
+            data["CreationDate"] = ifcopenshell.util.date.ifc2datetime(data["CreationDate"])
+            data["StartTime"] = ifcopenshell.util.date.ifc2datetime(data["StartTime"])
            if data["FinishTime"]:
-                data["FinishTime"] = ifcopenshell.util.date.ifc2datetime(data["FinishTime"]).isoformat()
+                data["FinishTime"] = ifcopenshell.util.date.ifc2datetime(data["FinishTime"])
            cls.work_plans[work_plan.id()] = data

    @classmethod
@@ -47,35 +48,19 @@ class Data:
            del data["OwnerHistory"]
            if data["Creators"]:
                data["Creators"] = [p.id() for p in data["Creators"]]
-            data["CreationDate"] = ifcopenshell.util.date.ifc2datetime(data["CreationDate"]).isoformat()
-            data["StartTime"] = ifcopenshell.util.date.ifc2datetime(data["StartTime"]).isoformat()
+            data["CreationDate"] = ifcopenshell.util.date.ifc2datetime(data["CreationDate"])
+            data["StartTime"] = ifcopenshell.util.date.ifc2datetime(data["StartTime"])
            if data["FinishTime"]:
-                data["FinishTime"] = ifcopenshell.util.date.ifc2datetime(data["FinishTime"]).isoformat()
+                data["FinishTime"] = ifcopenshell.util.date.ifc2datetime(data["FinishTime"])
            cls.work_schedules[work_schedule.id()] = data

    @classmethod
    def load_work_calendars(cls):
        for work_calendar in cls._file.by_type("IfcWorkCalendar"):
            data = work_calendar.get_info()
-            del data["OwnerHistory"]     
-            ##### HOW DO WE NEST ENTITIES SUCH AS WORKTIME? ####       
-            ##### HOW TO ALLOW DISPLAY OF TIME? AND DATES? ####   
+            del data["OwnerHistory"]
            del data["WorkingTimes"]
            del data["ExceptionTimes"]
-            # if data["WorkingTimes"]:
-            #     for worktime in data["WorkingTimes"]:
-            #         worktime_data = {}
-            #         if worktime.Start:                   
-            #             worktime_data["start"] = ifcopenshell.util.date.ifc2datetime(worktime.Start).isoformat()
-            #         if worktime.Start:
-            #             worktime_data["finish"] = ifcopenshell.util.date.ifc2datetime(worktime.Start).isoformat()
-            #         worktime = worktime_data
-            # if data["ExceptionTimes"]:
-            #     for exceptiontime in data["ExceptionTimes"]:
-            #         exceptiontime_data = {}
-            #         exceptiontime_data["start"] = ifcopenshell.util.date.ifc2datetime(exceptiontime.Finish).isoformat()
-            #         exceptiontime_data["finish"] = ifcopenshell.util.date.ifc2datetime(exceptiontime.Finish).isoformat()
-            #         exceptiontime = exceptiontime_data
            cls.work_calendars[work_calendar.id()] = data

    @classmethod
@@ -0,0 +1,21 @@
+import ifcopenshell.util.date
+
+
+class Usecase:
+    def __init__(self, file, **settings):
+        self.file = file
+        self.settings = {"recurrence_pattern": None, "attributes": {}}
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        for name, value in self.settings["attributes"].items():
+            if name == "TimePeriods" and value:
+                periods = []
+                for period in value:
+                    periods.append(self.file.create_entity("IfcTimePeriod", **{
+                        "StartTime": ifcopenshell.util.date.datetime2ifc(period[0]),
+                        "EndTime": ifcopenshell.util.date.datetime2ifc(period[1])
+                    }))
+                value = periods
+            setattr(self.settings["recurrence_pattern"], name, value)
@@ -1,13 +1,10 @@
 class Usecase:
    def __init__(self, file, **settings):
        self.file = file
-        self.settings = {
-            "work_calendar": None,
-            "attributes": {}
-        }
+        self.settings = {"work_calendar": None, "attributes": {}}
        for key, value in settings.items():
            self.settings[key] = value

    def execute(self):
        for name, value in self.settings["attributes"].items():
-            setattr(self.settings["work_calendar"], name, value)
+            setattr(self.settings["work_calendar"], name, value)
@@ -1,13 +1,10 @@
 class Usecase:
    def __init__(self, file, **settings):
        self.file = file
-        self.settings = {
-            "work_plan": None,
-            "attributes": {}
-        }
+        self.settings = {"work_plan": None, "attributes": {}}
        for key, value in settings.items():
            self.settings[key] = value

    def execute(self):
        for name, value in self.settings["attributes"].items():
-            setattr(self.settings["work_plan"], name, value)
+            setattr(self.settings["work_plan"], name, value)
@@ -1,13 +1,10 @@
 class Usecase:
    def __init__(self, file, **settings):
        self.file = file
-        self.settings = {
-            "work_schedule": None,
-            "attributes": {}
-        }
+        self.settings = {"work_schedule": None, "attributes": {}}
        for key, value in settings.items():
            self.settings[key] = value

    def execute(self):
        for name, value in self.settings["attributes"].items():
-            setattr(self.settings["work_schedule"], name, value)
+            setattr(self.settings["work_schedule"], name, value)
@@ -0,0 +1,15 @@
+import ifcopenshell.util.date
+
+
+class Usecase:
+    def __init__(self, file, **settings):
+        self.file = file
+        self.settings = {"work_time": None, "attributes": {}}
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        for name, value in self.settings["attributes"].items():
+            if name in ["Start", "Finish"]:
+                value = ifcopenshell.util.date.datetime2ifc(value, "IfcDate")
+            setattr(self.settings["work_time"], name, value)
@@ -7,8 +7,10 @@ class Usecase:

    def execute(self):
        # TODO: do a deep purge
-        if self.settings["work_calendar"].HasContext:
-            rel_declares = self.settings["work_calendar"].HasContext[0]
-            if len(rel_declares.RelatedDefinitions) == 1:
-                self.file.remove(rel_declares)
+        ifcopenshell.api.run(
+            "project.unassign_declaration",
+            self.file,
+            definition=self.settings["work_calendar"],
+            relating_context=self.file.by_type("IfcContext")[0],
+        )
        self.file.remove(self.settings["work_calendar"])
@@ -7,8 +7,10 @@ class Usecase:

    def execute(self):
        # TODO: do a deep purge
-        if self.settings["work_plan"].HasContext:
-            rel_declares = self.settings["work_plan"].HasContext[0]
-            if len(rel_declares.RelatedDefinitions) == 1:
-                self.file.remove(rel_declares)
+        ifcopenshell.api.run(
+            "project.unassign_declaration",
+            self.file,
+            definition=self.settings["work_plan"],
+            relating_context=self.file.by_type("IfcContext")[0],
+        )
        self.file.remove(self.settings["work_plan"])
@@ -7,8 +7,10 @@ class Usecase:

    def execute(self):
        # TODO: do a deep purge
-        if self.settings["work_schedule"].HasContext:
-            rel_declares = self.settings["work_schedule"].HasContext[0]
-            if len(rel_declares.RelatedDefinitions) == 1:
-                self.file.remove(rel_declares)
+        ifcopenshell.api.run(
+            "project.unassign_declaration",
+            self.file,
+            definition=self.settings["work_schedule"],
+            relating_context=self.file.by_type("IfcContext")[0],
+        )
        self.file.remove(self.settings["work_schedule"])