Celem aplikacji jest umożliwienie użytkownikowi znalezienia połączenia między dwoma wybranymi miastami, korzystając z podanych przez niego parametrów. Bazę danych stanowi plik "connections.csv", którego zawartość można edytować z poziomu programu.
Drzewko interface'u prezentuje się następująco:
Znajdź połączenie
Opcja ta umożliwia użytkowniki znaleźć połączenie między dwoma podanymi przez niego miastami. Dodatkowo użytkowni musi podać informacje odnośnie typu wyszukiwania:
- Połączenie najtańsze
- Połączenie najszybsze
- Połączenie najkrótsze
Może także zdecydować, o typie połączeń jakie go interesują:
- Połączenia pociągiem
- Połączenia autobusem
- Obydwa powyższe rodzaje połączeń
Zaplanuj podróż
Wybierając tą opcję użytkownik zostanie poproszony o podanie listy miejsc, które chciałby odwiedzić. Na jej podstawie oraz na podstawie podanych przez niego parametrów utworzona zostanie lista połączeń w taki sposób, aby odwiedzić wszystkie podane przez niego miejscaDodaj połączenie
Użytkownik będzie mógł ręcznie dodać połączenie między dwoma miastami. Zostanie poproszony o podanie:
- Nazwy pierwszego miasta
- Nazwy drugiego miasta
- Ceny tego połączenia [zł]
- Długości tego połączenia [m]
- Czasu tego połączenia [min]
- Typu połączenia: Autobus/Pociąg
Po dodaniu połączenia automatycznie zostanie nadany mu odpowiedni indeks, a miasta między którymi dane połączenie występuje, zaktualizują informacje o wystąpieniu stacji autobusowej lub stacji dla pociągów.
Linux (program testowany był na distro Ubuntu)
W celu skompilowania programu w terminalu należy wpisać polecenie make.
W celu wywołania aplikacji w terminu należy wpisać polecenie ./RouteFinder.out
W celu uruchomienia testów jednostkowych należy wpisać w terminalu serię poleceń:
- make run_tests
- ./tests.out
Główne
- City
- Route
- DirectConnection
- Connection
- Matrix
- DataBase
- FinderAlgorithm
- RouteFinder
Dodatkowe
- Interface
- Tests
- struktury wyjątów
Opis klasy:
Klasa reprezentująca miasta. Posiada zestaw metod pozwalających uzystkać dostęp do atrybutów. Dodatkowo każdy obiekt (miasto) posiada inforormcję o wystąpieniu stacji autobusowej bądź stacji dla pociągów.
Atrybuty:
- std::string name;
nazwa miasta- bool isTrain;
czy miasto zawiera stację dla pociągów- bool isBus;
czy miasto zawiera stację autobusową
Metody:
- City(std::string n="", bool isTrain=false, bool isBus=false);
- std::string get_name() const;
- bool isBusStation() const;
- bool isTrainStation() const;
- void setTrainStation(bool const& b);
- void setBusStation(bool const& b);
- bool operator==(City const& other_city) const;
- bool operator!=(City const& other_city) const;
- friend std::ostream& operator<<(std::ostream& os, City const& ct);
Opis klasy:
Klasa abstrakcyjna. Utworzona została jako rodzic do klasy DirectConnection oraz klasy Connection. Obie te klasy korzystają z podobnego zestawu metod i atrybutów, tak więc w celu uniknięcia redundancji napisana została klasa Route. Nie można utworzyć obiektów typu Route.
Atrybuty:
- unsigned int connection_id;
unikalne ID połączenia- unsigned int distance;
odległość połączenia- unsigned int cost;
koszt połączenia- unsigned int time;
czas połączenia- City PlaceA;
miasto pierwsze- City PlaceB;
miasto drugie
Metody:
- Route(unsigned int id, unsigned int d, unsigned int c, unsigned int t, City const& PA, City const& PB);
konstruktor klasy- virtual void print_connection_details() = 0;
wirtualna metoda wyświetlająca szczegóły połączenia- unsigned int get_connection_id();
- unsigned int get_distance() const;
- unsigned int get_cost() const;
- unsigned int get_time() const;
- City get_PlaceA() const;
- City get_PlaceB() const;
- City& get_modifable_PlaceA();
- City& get_modifable_PlaceB();
Opis klasy:
Klasa dziedzicząca po klasie Route. Reprezentuje bezpośrednie połączenie między dwoma miastami.
Atrybuty:
- station_type type;
station type to specjalnie utworzony typ enum, atrybut ten przechowuje czy dane połączenie jest połączeniem autobusowym, czy korzystając z pociągu
Metody:
- DirectConnection(unsigned int id, unsigned int d, unsigned int c, unsigned int t, City const& PA, City const& PB, station_type tp);
- unsigned int get_connection_id() const;
- station_type get_type() const;
- bool operator==(DirectConnection dc);
- bool operator!=(DirectConnection dc);
- friend std::ostream& operator<<(std::ostream& os, DirectConnection const& dc);
- virtual void print_connection_details();
przeciążona metoda wyświetlające szczegóły połączenia
Opis klasy:
Klasa dziedzicząca po klasie Route. Reprezentuje połączenie między dwoma miastami. W porównaniu do DirectConnection, połączenie te nie musi być bezpośrednie. W atrybutach posiada listę DirectConnections, z których składa się połączenie. Dodatkowo posiada listę miast, w których następuje przesiadka.
Atrybuty:
- std::vector<DirectConnection*> connection_elements;
wektor połączeń bezpośrednich, z których składa się połączenie- std::vector<City> changes_list;
wektor miast, w których następuje przesiadka
Metody:
- Connection(City PA, City PB);
- std::vector<DirectConnection*> get_connection_elements() const;
- unsigned int get_connection_id();
- void add_direct_conection(DirectConnection* dc);
metoda dodająca połączenie bezpośrednie do listy połączeń. Automatycznie dodawane są przesiadki- void set_id(unsigned int id);
- friend std::ostream& operator<<(std::ostream& os, Connection const& cnt);
- void print_connection_details();
Przeciążona metoda wyświetlająca szczegóły połączenia
Opis klasy:
Klasa kontenerowa. Reprezentuje macierz połączeń potrzebną do przeprowadzenia algorytmu wyszukującego połączenia z zadanymi parametrami. Jest macierzą symetryczną, kwadratową. Elementami macierzy są wskaźniki na połączenia bezpośrednie.
Atrybuty:
- DirectConnection ***p;
- unsigned int size;
- std::vector<City> cites;
wektor miast występujących w macierzy, w kolejności dodawania
Metody prywatne:
- void extend_matrix();
prywatna metoda rozszerzająca macierz o jeden wiersz i jedną kolumnę
Metody:
- Matrix();
- Matrix(Matrix const& matrix_to_copy);
konstruktor kopiujący- unsigned int get_size() const;
- std::vector<City> get_cities() const;
- Matrix & operator=(Matrix const& matrix_to_assign);
- DirectConnection* operator()(City const& CityA, City const& CityB); operator() zwracający wskaźnik na połączenie bezpośrednie na podstawie miast
- DirectConnection* operator()(int i, int j);
operator() zwracający wskaźnik na połączenie bezpośrednie na podstawie indeksów w macierzy- void add_connection(DirectConnection *cnt);
metoda rozszerzająca macierz i dodająca nowe połączenie (lub zastępująca aktualne połączenie)- bool isCity(City const& city) const;
metoda sprawdzająca czy w macierzy znajduje się połączenie zawierające dane miasto- std::string description() const;
metoda zwracająca opis macierzy- void print_matrix();
- void clean(); metoda zmieniająca wszystkie pola macierzy na nullptr
- ~Matrix();
destruktor czyszczący pamięć po wskaźnikach
Opis klasy:
Klasa reprezentująca bazę danych. Zawiera metody komunikacji z plikiem oraz metody tworzące macierze na podstawie zadanych parametrów. Zawiera wszystkie potrzebne elementy do przeprowadzenie udanego algorytmu wyszukiwania. Dodatkowo za pomocą tej klasy można zapisać nowe połączenia do pliku.
Atrybuty:
- std::vector<DirectConnection> connections;
wektor wszystkich połączeń bezpośrednich odczytanych z pliku- std::vector<City> cities;
wektor wszystkich miast występujących w połączeniach odczytanych z pliku- Matrix current_matrix;
akturalnie przechowywana macierz połączeń- possible_type current_station_type;
informacja o rodzajach połączeń w macierzy: train/bus/both- possible_search_setting current_search_setting;
informacja o ustawieniach macierzy: najtańsze/najszybsze/najkrótsze- std::string path;
ścieżka do pliku połączeń
Metody prywatne:
- void add_city_using_connection(DirectConnection const& dc);
metoda dodająca miasta na podstawie DirectConnection- std::vector<City> city_using_info(std::string const& nameA, std::string const& nameB, station_type type);
metoda dodająca miasta (lub edytująca obecne miasta) na podstawie zaledwie 3 informacji z DirectConnection, dodatkowo zwraca wektor z dodanymi miastami
Metody:
- DataBase();
- DataBase(std::string const& filepath);
- DataBase(std::string const& filepath, std::vector<DirectConnection> c);
- void add_direct_connection(DirectConnection const& dc);
- void add_direct_connection(unsigned int dist, unsigned int cost, unsigned int time, std::string const& PlaceA, std::string const& PlaceB, station_type type);
Dodaje połączenie na podstawie informcji od użytkownika, bez konieczności wcześniejszego tworzenia obiektu typu City, ani znajomości indeksu (autoindeksowanie)- possible_search_setting get_current_setting() const;
- possible_type get_current_stations_type() const;
- Matrix get_current_matrix() const;
- std::vector<DirectConnection> get_connections();
- std::vector<City> get_cities() const;
- void set_file_path(std::string const& p);
- void create_cheapest_matrix(possible_type const& type);
- void create_fastest_matrix(possible_type const& type);
- void create_shortest_matrix(possible_type const& type);
Trzy powyższe metody "create" tworzą na podstawie wektora połączeń bezpośrednich macierz o konkretnych właściwościach tj. wybór opcji create_cheapest_matrix(BUS) utworzy macierz z najtańszymi połączeniami (jeżeli istnieje więcej niż jedno połączenie między tymi samymi miastami). Dodatkowo wszystkie te połączenia będą autobusowe.- void update_data_base() const;
aktualizuje plik, jeżeli dodano nowe połączenia manualnie- void load_file();
ładuje połączenia z pliku
Opis klasy:
Klasa odpowiadająca za przeprowadzenie algorytmu wyszukiwania na podstawie podanych miast, ustawień, oraz macierzy połączeń.
Atrybuty:
- Matrix connections_matrix;
macierz połączeń bezpośrednich- std::vector<int> distance;
- std::vector<int> previous;
- std::vector<City> used;
- std::vector<City> cities;
wektory pomocniczne dla algorytmu
Metody prywatne:
- bool is_used(City const& ct) const;
- City min_city_node() const;
- int find_city_index(City const& ct);
Metody:
- FinderAlgorithm(Matrix const& cm);
- FinderAlgorithm();
- Matrix get_connetions_matrix() const;
- std::vector<int> get_distance() const;
- std::vector<int> get_previous() const;
- void set_connections_matrix(Matrix const& cm);
- Connection generate_connection_time(City const& PlaceA, City const& PlaceB);
- Connection generate_connection_cost(City const& PlaceA, City const& PlaceB);
- Connection generate_connection_dist(City const& PlaceA, City const& PlaceB);
- Connection generate_connection(City const& PlaceA, City const& PlaceB);
- Connection generate_connection_setting(City const& PlaceA, City const& PlaceB, possible_search_setting s_set);
- void dijkstra_dist(City const& PlaceA);
- void dijkstra_time(City const& PlaceA);
- void dijkstra_cost(City const& PlaceA);
- void reset();
Opis klasy:
Główna klasa całego programu. W swoich atrybutach posiada bazę danych oraz obiekt typu FinderAlgorithm. Łączy ich działanie w całość oraz zawiera proste, gotowe do użycia przez interface metody.
Atrybuty:
- DataBase db;
obiekt typu DataBase wykorzystywany do tworzenia macierzy i odczytu z plików- FinderAlgorithm FA;
>obiekt typu FinderAlgorithm komunikujący się z bazą danych i wyszukujący połączeń- City UserCityA;
- City UserCityB;
Metody:
- RouteFinder(std::string const& filepath);
- Connection find_user_connection(std::string const& nameA, std::string const& nameB, possible_search_setting setting, possible_type type);
- City find_city(std::string const& name);
- DataBase& get_db();
Opis klasy
Klasa odpowiadająca za interakcję z użytkownikiem. Zawiera metody poprawiające czytelność programu. Aby uruchomić aplikację należy stworzyć obiekt typu Interface, a następnie wywołać metodę run_interface(). Żadne dodatkowe ustawienia nie są wymagane.
Metody:
- Interface();
- void run_interface();
metoda uruchamiająca całą aplikację- int choose_function();
- enum possible_search_setting choose_setting();
- enum possible_type choose_type();
Opis klasy
Klasa przeprowadzająca testy jednostkowe. Zawiera szereg metod prywatnych testujących działanie aplikacji. Aby uruchomić je wszystkie zwyczajnie należy stworzyć obiekt tej klasy, a następnie wywołać metodę run_test(). W terminalu pojawi się wtedy informacja o przebiegu wszystkich testów.
Metody prywatne:
- void test_City() const;
- void test_Connection() const;
- void test_DirectConnection() const;
- void test_DataBase() const;
- void test_FinderAlgorithms() const;
- void test_Matrix() const;
- void test_RouteFinder() const;
Metody:
- void run_test() const;
metoda uruchamiająca testy jednostkowe
Przeznaczenie struktur
Struktury wyjątków napisane zostały w celu obsługi błędów programu. W konstruktorze przyjmują ciąg znaków string stanowiący wiadomość o błędzie. Wykorzystywane są w aplikacji w miejscach, które mogą stanowić problem ( np. nie udało się znaleźć połączenia z podanymi parametrami ).
Wyjątki:
- MyException
- dcAlreadyAddedError
- StationTypeError
- CityNotFoundException
- DCNotFoundException
- ConnectionNotFoundException
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent