Added 'PlantUML-Diagrams' as basis for documentation

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added ConfigFailFastSpec to properly test whether ConfigFailFast works as expected [#300](https://github.com/ie3-institute/MobilitySimulator/issues/300)
 - Implemented GitHub Actions Pipeline [#351](https://github.com/ie3-institute/MobilitySimulator/issues/351)
 - Added some infrastructure for GHA pipeline [#371](https://github.com/ie3-institute/MobilitySimulator/issues/371)
+- Added 'PlantUML-Diagrams' as basis for documentation [#382](https://github.com/ie3-institute/MobilitySimulator/issues/382) 
 
 ### Changed
 - Changed sets of evs from sorted to unsorted [#113](https://github.com/ie3-institute/MobilitySimulator/issues/113)

docs/uml/schematic_process.puml

@@ -0,0 +1,37 @@
+@startuml
+(*) --> "Initialise Simulation Parameter"
+if "Determine Type of Day" then
+    --> "Working Day"
+    --> "Load Day Type Parameters"
+else
+    --> "Saturday"
+
+    --> "Load Day Type Parameters"
+
+    --> "Initialise Trip Journal"
+
+    --> "Determine first Departure"
+
+    --> "Determine next Target State"
+
+    --> "Determine Driving Distance"
+
+    --> "Determine Driving Speed"
+
+    --> "Calculate Parking Duration"
+
+
+    if "Last trip of this day" then
+        [yes] if "All vehicles simulated?" then
+            --> [yes] (*)
+        else
+             --> [no]  "Initialise Trip Journal"
+                    endif
+    else
+     --> [no] "Determine next Target State"
+    endif
+
+else
+    --> "Sunday"
+    --> "Load Day Type Parameters"
+@enduml

docs/uml/schematic_process_short.puml

@@ -0,0 +1,31 @@
+@startuml
+(*) --> "Initialise Simulation Parameter"
+if "Determine Type of Day" then
+    --> "Working Day"
+    --> "Load Day Type Parameters"
+else
+    --> "Saturday"
+
+    --> "Load Day Type Parameters"
+
+    --> "Initialise Trip Journal"
+
+    --> "Determine first Departure"
+
+    --> "Determine\n - next Target State\n - Driving Distance\n - Driving Speed\n - Parking Duration"
+
+
+    if "Last trip of this day" then
+        [yes] if "All vehicles simulated?" then
+            --> [yes] (*)
+        else
+             --> [no]  "Initialise Trip Journal"
+                    endif
+    else
+     --> [no] "Determine\n - next Target State\n - Driving Distance\n - Driving Speed\n - Parking Duration"
+    endif
+
+else
+    --> "Sunday"
+    --> "Load Day Type Parameters"
+@enduml

docs/uml/schematic_process_while_loop.puml

@@ -0,0 +1,23 @@
+ @startuml
+start
+switch (Determine Type of Day)
+case ()
+  :Weekday;
+case ()
+  :Saturday;
+case ()
+  :Sunday;
+endswitch
+    :Load Day Type Parameters;
+    repeat
+    :Initialise Trip Journal;
+      :Determine first Departure;
+    repeat
+    :Determine next Target State\nDetermine Driving Distance\nDetermine Driving Speed\nDetermine next Departure\nCalculate Parking Duration;
+    :Simulate Trip and\nadd to Trip Journal;
+    repeat while (Next Departure today) is (yes) not (no)
+repeat while (All vehicles simulated?) is (no) not (yes)
+: Continue with next Day;
+stop
+@enduml
+