Skip to main content

Design

System high-level description​

The user will open OptiMap and be presented the front-end pages. The user can log-in sign-up which will all be handled by the front-end and the functions and variables involved are described in figure 1.0. The users information will be stored in a database which will keep the data safe and encrypted. After authentication, the user will be presented with the map view where they can search for locations they want to travel to. They will have an option to create a route and save that route. The saved routes will also be stored in the the database and the user can refer to them at any time they want and run the saved routes. The user can put restirctions on his routes on their settings page. For example, if the user wants to avoid highways optimap will adjust the route accordingly.

Front-end Class Diagram​

The LoginScreen class handles user's login credentials. The HomeScreen class shows the users the routes they have taken before and saved, along with directions. It then links to other classes such as MapView, RouteInput, NotificationPopup, and Settings. The MapView class shows the user the map of their route and allows them to interact with it, such as zooming in and out. The RouteInput class is where the user enters the locations they want to visit, and the time they plan to spend at each location. The NotifcationPopup class will allow the user to know if their planned route is not possible due to certain constraints such as traffic or time. The Settings class lets the user specify the time they plan to finish the route or other factors that would affect the route optimization.

Figure 1.0, Front-end class Diagram

The LoginScreen class handles user's login credentials. The HomeScreen class shows the users the routes they have taken before and saved, along with directions. It then links to other classes such as MapView, RouteInput, NotificationPopup, and Settings. The MapView class shows the user the map of their route and allows them to interact with it, such as zooming in and out. The RouteInput class is where the user enters the locations they want to visit, and the time they plan to spend at each location. The NotifcationPopup class will allow the user to know if their planned route is not possible due to certain constraints such as traffic or time. The Settings class lets the user specify the time they plan to finish the route or other factors that would affect the route optimization.

Back-end Class Diagram​

Figure 1.1, Back-end class Diagram

The database class stores and retrieves data for other classes, such as, including user data, route data, notification service data, optimizer data, and traffic API data. TrafficAPI class handles traffic data which will then be sent to the optimizer class to optimize the route based on real-time traffic conditions. Route class contains information regarding a specific route, such as the locations and time expected to spend at each location. The optimizer class handles finding the optimal route for the user's inputted location, time constraints, and any other factors. It uses Dijkstra's algorithm and references the TrafficAPI to get traffic data for better optimization. NotificationServices class is responsible to notify the user if their planned route is not possible or if their are any other issues such as traffic or road blockage. The User class contains user information such as, login credentials, saved routes, route history, and directions. It has methods for

Database Diagram​

Figure 1.2, Database diagram

Figure 1.2 above shows the database design diagram of Optimap. We can see the table Users which will contain the userid the username and password. The UserId will be used as a primary key that will be used when accessing the favorite routes, recent routes and saved routes. The Favorite routes table contains the userid column which will have the id of the user it belongs to and the favrouteId which will be used as a primary key to connect the Route table. The Recent routes and Saved routes tables work in the same way. The Route table contains the routeid, locationid, timestamp and the ids of the favorite routes,recent routes, and saved routes id if it belongs to any. Every route has multiple locations and we use the primary key locationid. ALl of these could change depending whether the database is SQL or noSQL.

Sequence Diagrams​

Sequence Diagram 1 (Use Case #1)​

UserHomeScreenCreateRouteScreenAddLocationDijkstrasAlgoGoogleMapsAPIMapViewNavigates to Home ScreenSelects 'Create Route'Add location (addLocation())Requests location search (requestLocation())Returns search resultsSends selected locationDisplays location on map (displayLocation())Add location again (addLocation())Requests location search (requestLocation())Returns search resultsSends selected locationDisplays location on map (displayLocation())Add location again (addLocation())Requests location search (requestLocation())Returns search resultsSends selected locationDisplays location on map (displayLocation())optimizeRoute()Optimized RoutestartRoute()UserHomeScreenCreateRouteScreenAddLocationDijkstrasAlgoGoogleMapsAPIMapView

Figure 1.3, Use Case #1 Sequence Diagram: As a user, I would like to be able to add as many destinations as I want to my route

  1. The User opens the OptiMap app
  2. The User selects "Create Route"
  3. OptiMap displays input box and MapView
  4. The User types in a location
  5. OptiMap requests and verifies location
  6. The User selects "Add Stop"
  7. OptiMap displays stop on map
  8. The User repeats this process until satisfied
  9. The User selects Start Route

Sequence Diagram 2 (Use Case #2)​

Accessing Previous Routes from Saved TripsUserOptiMapDatabaseLogs inDisplays DashboardClicks on "Recent Trips"Requests the list of recent trips for the UserReturns the list of recent trips for the UserDisplays the list of recent tripsSelects a saved route from the listRequests the details of the selected saved routeReturns the details of the selected saved routeDisplays the details of the selected saved routeConfirms to use the selected saved routeRedirects to the selected saved routeUserOptiMapDatabaseAccessing Previous Routes from Saved Trips

Figure 1.4, Use Case #2 Sequence Diagram: As a user, I would like to be able to access previous routes that I have saved

  1. The User opens the OptiMap app
  2. The User selects "Recent Trips"
  3. OptiMap requests database for saved trips
  4. OptiMap displays saved trips to the User
  5. The User selects a saved trip
  6. OptiMap displays details of the selected trip
  7. User selects "confirm"
  8. OptiMap redirects User to the route on MapView

Sequence Diagram 3 (Use Case #3)​

ActorHomeScreenCreateRouteScreenTransportationButtonopens appselects "Create Route"chooses to change transportation modechanged to bicycleActorHomeScreenCreateRouteScreenTransportationButton

Figure 1.5, Use Case #3 Sequence Diagram: As a user, I would like to be able to change the mode of transportation to further optimize my route

  1. The User opens the OptiMap app
  2. The User selects "Create Route"
  3. OptiMap displays transportation methods option beside input box
  4. The User selects bicycle transportation mode
  5. OptiMap changes transportation mode to bicycle

Sequence Diagram 4 (Use Case #4)​

Figure 1.6, Use Case #4 Sequence Diagram: As a user, I would like to be able to set arrival times to each destination to further optimize my route

  1. The User opens the OptiMap app
  2. The User selects "Create Route"
  3. OptiMap displays input box and MapView
  4. The User types in a location
  5. OptiMap requests and verifies location
  6. The User sets the arrival time for the location in another input box
  7. The User selects "Add Stop"
  8. OptiMap optimizes route by requesting distance and time information for all locations from Google Maps API
  9. The User selects "Start Route"

Sequence Diagram 5 (Use Case #5)​

Rerouting in special circumstancesUserHomeScreenCreateRouteScreenAddLocationGoogleMapsAPIDijkstrasAlgoMapViewExceptionHandlerAdd every locationloop[i < numOfLocations]Navigates to Home ScreenSelects 'Create Route'Add LocationRequest LocationReturn search resultsSends Selected LocationoptimizeRoute()Optimized RoutestartRoute()Road is closedoptimizeRoute(different weights)Optimized RouteUpdate RouteUserHomeScreenCreateRouteScreenAddLocationGoogleMapsAPIDijkstrasAlgoMapViewExceptionHandlerRerouting in special circumstances

Figure 1.7, Use Case #5 Sequence Diagram: As a user, I would like for my route to be rerouted on the basis of various road and traffic conditions

  1. The User opens the OptiMap app
  2. The User selects "Create Route"
  3. The User enters desired destinations and clicks "Start Route"
  4. OptiMap displays optimized route to User
  5. Google Maps API notifies OptiMap of road closure
  6. OptiMap re-runs optimization on different roads
  7. OptiMap updates the map view and displays newly optimized route

State Diagram​

Start
Success
Fail
Firebase DB Request
Enter Destination
Route Optimization
Close App
Selected
Real-Time Update
LoginView
Authentication
MenuScreen
ErrorScreen
SavedRoutes
SelectFromSaved
FindRoute
Profile
AccountView
MapView
SearchDestination
ShowRoute
SelectTransportationMode
UpdateRoute

Figure 1.8, State Diagram

Algorithm Description​

The application will only use one algorithm and it is Dijsktra's algorithm to help find the shortest distance between each location inputted by the user. Dijkstra's algorithm will be used in the Optimizer class to help achieve that function. The Optimizer class allows for user input in the form of a list of locations and then Dijsktra's algorithm will help assign weights to each location to help find the shortest path. The weights allow for the algorithm to keep track of the currently known shortest distance from node to node and updates if a shorter path is found. This process continues until all nodes are added from the user inputted list. Once that is complete, the list of locations will be reordered into the fastest path and then displayed to the user. Running dijkstras algorithm on our own machine may not be feasable due to the large amounts of computations needed, to mitigate this issue our group will try to look for different APIs such as the google maps API or any other maps API that will allow us to utilize dijkstras algorithm with our weights on their servers. Real-time factors such as traffic and road closures can impact the optimal route. The weight used to resort in that scenario would be time. As the real time factors are constantly changing, we will also update our database to reflect this. Every time there is a call to the optimization algorithm (or to the re-order function), we will make a database call that write to the given ID of the route that we are currently using and overwrite it with the new locations.

Edit this page
Revision Historynothing
AuthorRevisionDate
Last updated by rickwu135