com.graphhopper.routing

Class AbstractRoutingAlgorithm

java.lang.Object

com.graphhopper.routing.AbstractRoutingAlgorithm

All Implemented Interfaces:

RoutingAlgorithm

Direct Known Subclasses:

AbstractBidirAlgo, AStar, Dijkstra, DijkstraOneToMany

public abstract class AbstractRoutingAlgorithm
extends Object
implements RoutingAlgorithm

Author:

Peter Karich

Field Summary

Fields

Modifier and Type	Field and Description
protected FlagEncoder	flagEncoder
protected Graph	graph
protected EdgeExplorer	inEdgeExplorer
protected int	maxVisitedNodes
protected NodeAccess	nodeAccess
protected EdgeExplorer	outEdgeExplorer
protected TraversalMode	traversalMode
protected Weighting	weighting

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected boolean	accept(EdgeIterator iter, int prevOrNextEdgeId)
List<Path>	calcPaths(int from, int to) Calculates multiple possibilities for a path.
protected void	checkAlreadyRun()
protected Path	createEmptyPath()
protected SPTEntry	createSPTEntry(int node, double weight)
protected abstract Path	extractPath() To be overwritten from extending class.
protected abstract boolean	finished() To be overwritten from extending class.
String	getName()
protected boolean	isMaxVisitedNodesExceeded()
RoutingAlgorithm	setEdgeFilter(EdgeFilter additionalEdgeFilter)
void	setMaxVisitedNodes(int numberOfNodes) Limit the search to numberOfNodes.
String	toString()
protected void	updateBestPath(EdgeIteratorState edgeState, SPTEntry bestSPTEntry, int traversalId)

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 Detail

graph

protected final Graph graph

nodeAccess

protected NodeAccess nodeAccess

inEdgeExplorer

protected EdgeExplorer inEdgeExplorer

outEdgeExplorer

protected EdgeExplorer outEdgeExplorer

weighting

protected final Weighting weighting

flagEncoder

protected final FlagEncoder flagEncoder

traversalMode

protected final TraversalMode traversalMode

maxVisitedNodes

protected int maxVisitedNodes

Constructor Detail

AbstractRoutingAlgorithm

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

Parameters:

graph - specifies the graph where this algorithm will run on

encoder - sets the used vehicle (bike, car, foot)

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

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

Method Detail

setMaxVisitedNodes

public void setMaxVisitedNodes(int numberOfNodes)

Description copied from interface: RoutingAlgorithm

Limit the search to numberOfNodes. See #681

Specified by:

setMaxVisitedNodes in interface RoutingAlgorithm

setEdgeFilter

public RoutingAlgorithm setEdgeFilter(EdgeFilter additionalEdgeFilter)

accept

protected boolean accept(EdgeIterator iter,
                         int prevOrNextEdgeId)

updateBestPath

protected void updateBestPath(EdgeIteratorState edgeState,
                              SPTEntry bestSPTEntry,
                              int traversalId)

checkAlreadyRun

protected void checkAlreadyRun()

createSPTEntry

protected SPTEntry createSPTEntry(int node,
                                  double weight)

finished

protected abstract boolean finished()

To be overwritten from extending class. Should we make this available in RoutingAlgorithm interface?

Returns:

true if finished.

extractPath

protected abstract Path extractPath()

To be overwritten from extending class. Should we make this available in RoutingAlgorithm interface?

Returns:

true if finished.

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()