uk.ac.newcastle.team22.usb.navigation

Class Navigator

java.lang.Object

uk.ac.newcastle.team22.usb.navigation.Navigator

public class Navigator
extends java.lang.Object

A class which calculates routes between locations in the Urban Sciences Building. The journey planner obeys constraints such as the user's accessibility requirements.

Version:

1.0

Author:

Daniel Vincent

Field Summary

Fields

Modifier and Type	Field and Description
static Navigator	shared The shared instance of the Urban Sciences Building navigator.

Constructor Summary

Constructors

Constructor and Description
Navigator()

Method Summary

Modifier and Type	Method and Description
java.util.List<Edge>	getRoute(Navigable destination, boolean accessibility) Calculate route from building entrance if no start position provided.
java.util.List<Edge>	getRoute(Navigable origin, Navigable destination, boolean accessibility) Calculates route from start navigable to end navigable.
java.util.List<Edge>	getRoute(Node destination, boolean accessibility) Calculate route from building entrance if no start position provided.
java.util.List<Edge>	getRoute(Node origin, Node destination, boolean accessibility) Calculate route from start Node to end Node.
java.util.List<Edge>	getTourRoute()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

shared

public static Navigator shared

The shared instance of the Urban Sciences Building navigator.

Constructor Detail

Navigator

public Navigator()

Method Detail

getRoute

public java.util.List<Edge> getRoute(Navigable origin,
                                     Navigable destination,
                                     boolean accessibility)

Calculates route from start navigable to end navigable.

Parameters:

origin - The origin of the journey.

destination - The destination of the journey.

accessibility - Boolean value whether the journey needs to be accessible.

Returns:

List of edges to be traversed to reach destination.

getRoute

public java.util.List<Edge> getRoute(Navigable destination,
                                     boolean accessibility)

Calculate route from building entrance if no start position provided.

Parameters:

destination - The destination of the journey.

accessibility - Boolean value whether the journey needs to be accessible.

Returns:

List of edges to be traversed to reach destination.

getRoute

public java.util.List<Edge> getRoute(Node destination,
                                     boolean accessibility)

Calculate route from building entrance if no start position provided.

Parameters:

destination - The destionation of the journey.

accessibility - Boolean value whether the journey needs to be accessible.

Returns:

List of edges to be traversed to reach destination.

getRoute

public java.util.List<Edge> getRoute(Node origin,
                                     Node destination,
                                     boolean accessibility)

Calculate route from start Node to end Node.

Parameters:

origin - The origin of the journey.

destination - The destination of the journey.

accessibility - Boolean value whether the journey needs to be accessible.

Returns:

List of edges to be traversed to reach the destination.

getTourRoute

public java.util.List<Edge> getTourRoute()

Returns:

List of edges to traverse for the Urban Sciences Building guided tour.