Merge pull request #55 from simulate-digital-rail/planning-state

Planning state

Author: arneboockmeyer

yaramo/geo_node.py

@@ -19,19 +19,20 @@ def __init__(self, x, y, **kwargs):
 
     @abstractmethod
     def get_distance_to_other_geo_node(self, geo_node_b: "GeoNode"):
+        """Returns to distance to the given other GeoNode."""
         pass
 
-    def to_serializable(self):
-        return self.__dict__, {}
-
     @abstractmethod
-    def to_wgs84(self):
+    def to_wgs84(self) -> "Wgs84GeoNode":
         pass
 
     @abstractmethod
-    def to_dbref(self):
+    def to_dbref(self) -> "DbrefGeoNode":
         pass
 
+    def to_serializable(self):
+        return self.__dict__, {}
+
 
 class Wgs84GeoNode(GeoNode):
     def get_distance_to_other_geo_node(self, geo_node_b: "Wgs84GeoNode"):

yaramo/topology.py

@@ -1,4 +1,6 @@
+from collections import defaultdict
 from datetime import datetime
+from enum import Enum
 
 import simplejson as json
 
@@ -11,10 +13,28 @@
 from yaramo.vacancy_section import VacancySection
 
 
+class PlanningState(Enum):
+    erstellt = 1
+    qualitaetsgeprueft = 2
+    plangeprueft = 3
+    freigegeben = 4
+    genehmigt = 5
+    abgenommen = 6
+    uebernommen = 7
+    gleichgestellt = 8
+    sonstige = 9
+
+    def __str__(self):
+        return self.name
+
+
 class Topology(BaseElement):
     """The Topology is a collection of all track elements comprising that topology.
 
     Elements like Signals, Nodes, Edges, Routes and Vacancy Sections can be accessed by their uuid in their respective dictionary.
+
+    The status_information provides additional information for each PlanningState, with the keys of the inner dict
+    being based on the PlanPro Akteur_Zuordnung class.
     """
 
     def __init__(self, **kwargs):
@@ -24,6 +44,8 @@ def __init__(self, **kwargs):
         self.signals: dict[str, Signal] = {}
         self.routes: dict[str, Route] = {}
         self.vacancy_sections: dict[str, VacancySection] = {}
+        self.current_status: PlanningState = PlanningState.erstellt
+        self.status_information: dict[PlanningState, dict[str, str]] = defaultdict(dict)
 
         self.created_at: datetime = datetime.now()
         self.created_with: str = "unknown"
@@ -83,12 +105,16 @@ def to_serializable(self):
             "routes": routes,
             "objects": objects,
             "vacany_sections": vacancy_sections,
+            "current_status": self.current_status.value,
+            "status_information": self.status_information,
         }, {}
 
     @classmethod
     def from_json(cls, json_str: str):
         obj = json.loads(json_str)
         topology = cls()
+        topology.current_status = PlanningState(obj.get("current_status", PlanningState.erstellt))
+        topology.status_information = obj.get("status_information", defaultdict(dict))
         for node in obj["nodes"]:
             node_obj = Node(**node)
             topology.add_node(node_obj)