Nutzerdokumentation

Nutzerdokumentation

Das Programm berechnet den kürzesten Weg zwischen zwei Punkten. Dafür muss der Nutzer eine Karten-Datei beilegen. Eine Standardkarte von Deutschland (germany_map.csv) ist dem Projekt beigelegt und kann hier gefunden werden.

Mehr Informationen zu der beigelegten Deutschlandkarte können hier gefunden werden.

Programmargumente

Das Programm kann mit den folgenden Flags/Argumenten aufgerufen werden. Die folgende Tabelle gibt eine kurze Übersicht:

Flag lang	Flag kurz	Erwartete folgende Argumente	Erklärung
--map	-m	Relativer oder absoluter Pfad zur Karten-Datei	Definiert die Karte, auf der die Reute berechnet werden soll
--start	-s	Name des Startpunkts	Definiert den Startpunkt
--target	-t	Name des Ziels	Definiert das Ziel
--debug	-d	keine	Aktiviert den Berechnungs-Debug-Modus

Einfache Routenführung starten

1. Navigieren Sie im Terminal in das Verzeichnis, das die ausführbare Programmdatei enthält.
2. Starten des Programms: .\routing_algorithm --map "/path/to/my/map.csv" --start Stuttgart --target Berlin (der Pfad zur Karte muss absolut sein)
3. Das Programm gibt nun den kürzesten Weg vom Start zum Ziel aus. Eine Ausgabe sieht wie folgt aus:

$ .\routing_algorithm -m /path/to/germany_map.csv -s Stuttgart -t Berlin

Target Berlin reached:
Stuttgart -> Nürnberg -> Dresden -> Berlin
Total distance: 560km
Enter the fuel efficiency of your car to get the fuel consumption for this route, or press n to exit:

4. Nun hat der Nutzer die Möglichkeit die Kosten der Fahrt berechnen zu lassen. Dafür muss der Verbrauch des Fahrzeugs pro Kilometer angegeben werden. Mit der Eingabe von n wird das Programm beendet.
5. Gibt der Nutzer einen Verbrauch ein, muss im nächsten Schritt der Preis pro Liter angeben werden (Komma wird mit einem Punkt dargestellt).

Der komplette Programmaufruf kann mit Eingabe von Verbrauch und Preis wie folgt aussehen:

$ .\routing_algorithm -m /path/to/germany_map.csv -s Stuttgart -t Berlin
Target Berlin reached:
Stuttgart -> Nürnberg -> Dresden -> Berlin
Total distance: 560km
Enter the fuel efficiency of your car to get the fuel consumption for this route, or press n to exit: 8.5
You need 47.60l of fuel for this trip
Enter the price per liter, or press n to exit: 1.89
The fuel for this trip will cost 89.96€

Process finished with exit code 0

Es muss immer eine Karte, ein Startpunkt und ein Ziel angeben werden. Es wird empfohlen den Dateipfad in Anführungszeichen anzugeben, sodass Leerzeichen nicht missinterpretiert werden.

Debug-Ausgabe

Das Programm bietet eine Debug-Ausgabe, die dem Nutzer mehr Informationen über die Berechnung der Route gibt. Diese Ausgabe kann über die --debug-Flag aktiviert werden: .\route-algo --debug --map "/path/to/my/map.csv" --start Stuttgart -t Berlin.

$ .\routing_algorithm -m /path/to/germany_map.csv -s Stuttgart -t Berlin -d
Stuttgart -> Karlsruhe
Total distance: 62km
Stuttgart -> Nürnberg
Total distance: 150km
Stuttgart -> München
Total distance: 190km
Stuttgart -> Freiburg
Total distance: 90km
Stuttgart -> Heilbronn
Total distance: 50km
Stuttgart -> Karlsruhe -> Düsseldorf
Total distance: 272km
Stuttgart -> Karlsruhe -> Hamburg
Total distance: 432km
Stuttgart -> Nürnberg -> Dresden
Total distance: 410km
Stuttgart -> Nürnberg -> Regensburg
Total distance: 270km
Stuttgart -> München -> Linz
Total distance: 390km
Stuttgart -> München -> Augsburg
Total distance: 260km
Stuttgart -> Karlsruhe -> Düsseldorf -> Bonn
Total distance: 332km
Stuttgart -> Karlsruhe -> Düsseldorf -> Köln
Total distance: 312km
Stuttgart -> Nürnberg -> Dresden -> Berlin
Total distance: 560km
Stuttgart -> Karlsruhe -> Hamburg -> Bremen
Total distance: 552km
Stuttgart -> Nürnberg -> Dresden -> Berlin -> Potsdam
Total distance: 595km
Target Berlin reached:
Stuttgart -> Nürnberg -> Dresden -> Berlin
Total distance: 560km
Enter the fuel efficiency of your car to get the fuel consumption for this route, or press n to exit: n