Package com.graphhopper.routing

Class AbstractRoutingAlgorithm

java.lang.Object

com.graphhopper.routing.AbstractRoutingAlgorithm

All Implemented Interfaces:

RoutingAlgorithm

Direct Known Subclasses:

AStar, Dijkstra, DijkstraOneToMany, ShortestPathTree

public abstract class AbstractRoutingAlgorithm
extends Object
implements RoutingAlgorithm

Author:

Peter Karich

Field Summary

Fields

Modifier and Type	Field	Description
protected final EdgeExplorer	edgeExplorer
protected final Graph	graph
protected int	maxVisitedNodes
protected final NodeAccess	nodeAccess
protected long	timeoutMillis
protected final TraversalMode	traversalMode
protected final Weighting	weighting

Constructor Summary

Constructors

Constructor	Description
AbstractRoutingAlgorithm(Graph graph, Weighting weighting, TraversalMode traversalMode)

Method Summary

Modifier and Type	Method	Description
protected boolean	accept(EdgeIteratorState iter, int prevOrNextEdgeId)
List<Path>	calcPaths(int from, int to)	Calculates multiple possibilities for a path.
protected void	checkAlreadyRun()
protected Path	createEmptyPath()
String	getName()
protected boolean	isMaxVisitedNodesExceeded()
protected boolean	isTimeoutExceeded()
void	setMaxVisitedNodes(int numberOfNodes)	Limit the search to numberOfNodes.
void	setTimeoutMillis(long timeoutMillis)	Limit the search to the given time in milliseconds
protected void	setupFinishTime()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.graphhopper.routing.RoutingAlgorithm

calcPath, getVisitedNodes

Field Details

graph

protected final Graph graph

weighting

protected final Weighting weighting

traversalMode

protected final TraversalMode traversalMode

nodeAccess

protected final NodeAccess nodeAccess

edgeExplorer

protected final EdgeExplorer edgeExplorer

maxVisitedNodes

protected int maxVisitedNodes

timeoutMillis

protected long timeoutMillis

Constructor Details

AbstractRoutingAlgorithm

public AbstractRoutingAlgorithm(Graph graph,
 Weighting weighting,
 TraversalMode traversalMode)

Parameters:

graph - specifies the graph where this algorithm will run on

weighting - set the used weight calculation (e.g. fastest, shortest).

traversalMode - how the graph is traversed e.g. if via nodes or edges.

Method Details

setMaxVisitedNodes

public void setMaxVisitedNodes(int numberOfNodes)

Description copied from interface: RoutingAlgorithm

Limit the search to numberOfNodes. See #681

Specified by:

setMaxVisitedNodes in interface RoutingAlgorithm

setTimeoutMillis

public void setTimeoutMillis(long timeoutMillis)

Description copied from interface: RoutingAlgorithm

Limit the search to the given time in milliseconds

Specified by:

setTimeoutMillis in interface RoutingAlgorithm

accept

protected boolean accept(EdgeIteratorState iter,
 int prevOrNextEdgeId)

checkAlreadyRun

protected void checkAlreadyRun()

setupFinishTime

protected void setupFinishTime()

calcPaths

public List<Path> calcPaths(int from,
 int to)

Description copied from interface: RoutingAlgorithm

Calculates multiple possibilities for a path.

Specified by:

calcPaths in interface RoutingAlgorithm

See Also:

• RoutingAlgorithm.calcPath(int, int)

createEmptyPath

protected Path createEmptyPath()

getName

public String getName()

Specified by:

getName in interface RoutingAlgorithm

Returns:

name of this algorithm

toString

public String toString()

Overrides:

toString in class Object

isMaxVisitedNodesExceeded

protected boolean isMaxVisitedNodesExceeded()

isTimeoutExceeded

protected boolean isTimeoutExceeded()