com.graphhopper.routing

Interface RoutingAlgorithm

All Known Subinterfaces:

BidirRoutingAlgorithm

All Known Implementing Classes:

AbstractBidirAlgo, AbstractBidirCHAlgo, AbstractBidirectionEdgeCHNoSOD, AbstractNonCHBidirAlgo, AbstractRoutingAlgorithm, AlternativeRoute, AlternativeRoute.AlternativeBidirSearch, AlternativeRouteCH, AlternativeRouteEdgeCH, AStar, AStarBidirection, AStarBidirectionCH, AStarBidirectionEdgeCHNoSOD, Dijkstra, DijkstraBidirectionCH, DijkstraBidirectionCHNoSOD, DijkstraBidirectionEdgeCHNoSOD, DijkstraBidirectionRef, DijkstraOneToMany

public interface RoutingAlgorithm

Calculates the shortest path from the specified node ids. Can be used only once.

Author:

Peter Karich

Method Summary

Modifier and Type	Method and Description
Path	calcPath(int from, int to) Calculates the best path between the specified nodes.
List<Path>	calcPaths(int from, int to) Calculates multiple possibilities for a path.
String	getName()
int	getVisitedNodes() Returns the visited nodes after searching.
void	setMaxVisitedNodes(int numberOfNodes) Limit the search to numberOfNodes.

Method Detail

calcPath

Path calcPath(int from,
              int to)

Calculates the best path between the specified nodes.

Returns:

the path. Call the method found() to make sure that the path is valid.

calcPaths

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

Calculates multiple possibilities for a path.

See Also:

calcPath(int, int)

setMaxVisitedNodes

void setMaxVisitedNodes(int numberOfNodes)

Limit the search to numberOfNodes. See #681

getName

String getName()

Returns:

name of this algorithm

getVisitedNodes

int getVisitedNodes()

Returns the visited nodes after searching. Useful for debugging.