com.graphhopper.routing

Class QueryGraph

java.lang.Object

com.graphhopper.routing.QueryGraph

All Implemented Interfaces:

Graph

public class QueryGraph
extends Object
implements Graph

A class which is used to query the underlying graph with real GPS points. It does so by introducing virtual nodes and edges. It is lightweight in order to be created every time a new query comes in, which makes the behaviour thread safe.

Author:

Peter Karich

Constructor Summary

Constructors

Constructor and Description
QueryGraph(Graph graph)

Method Summary

Modifier and Type	Method and Description
void	clearUnfavoredStatus() Removes the 'unfavored' status of all virtual edges.
Graph	copyTo(Graph g) Copy this Graph into the specified Graph g.
EdgeExplorer	createEdgeExplorer()
EdgeExplorer	createEdgeExplorer(EdgeFilter edgeFilter) Returns an EdgeExplorer which makes it possible to traverse all filtered edges of a specific node.
EdgeIteratorState	edge(int a, int b) Creates an edge between the nodes a and b.
EdgeIteratorState	edge(int a, int b, double distance, boolean bothDirections) Use edge(a,b).setDistance().setFlags instead
EdgeIteratorState	edge(int a, int b, double distance, int flags)
boolean	enforceHeading(int nodeId, double favoredHeading, boolean incoming) Set those edges at the virtual node (nodeId) to 'unfavored' that require at least a turn of 100° from favoredHeading
boolean	enforceHeadingByEdgeId(int nodeId, int edgeId, boolean incoming) Set one specific edge at the virtual node with nodeId to 'unfavored' to enforce routing along other edges
AllEdgesIterator	getAllEdges()
Graph	getBaseGraph()
BBox	getBounds() Returns the implicit bounds of this graph calculated from the lat,lon input of setNode
EdgeIteratorState	getEdgeIteratorState(int origEdgeId, int adjNode) Returns a wrapper over the specified edgeId.
GraphExtension	getExtension()
NodeAccess	getNodeAccess() Creates a node explorer to access node properties.
int	getNodes()
boolean	isVirtualEdge(int edgeId)
boolean	isVirtualNode(int nodeId)
void	lookup(List<QueryResult> resList) For all specified query results calculate snapped point and set closest node and edge to a virtual one if necessary.
QueryGraph	lookup(QueryResult fromRes, QueryResult toRes) Convenient method to initialize this QueryGraph with the two specified query results.
QueryGraph	setUseEdgeExplorerCache(boolean useEECache) This method is an experimental feature to reduce memory and CPU resources if there are many locations ("hundreds") for one QueryGraph.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryGraph

public QueryGraph(Graph graph)

Method Detail

lookup

public QueryGraph lookup(QueryResult fromRes,
                         QueryResult toRes)

Convenient method to initialize this QueryGraph with the two specified query results.

lookup

public void lookup(List<QueryResult> resList)

For all specified query results calculate snapped point and set closest node and edge to a virtual one if necessary. Additionally the wayIndex can change if an edge is swapped.

getBaseGraph

public Graph getBaseGraph()

Specified by:

getBaseGraph in interface Graph

Returns:

a graph which behaves like an unprepared graph and e.g. the normal unidirectional Dijkstra or any graph traversal algorithm can be executed.

isVirtualEdge

public boolean isVirtualEdge(int edgeId)

isVirtualNode

public boolean isVirtualNode(int nodeId)

setUseEdgeExplorerCache

public QueryGraph setUseEdgeExplorerCache(boolean useEECache)

This method is an experimental feature to reduce memory and CPU resources if there are many locations ("hundreds") for one QueryGraph. It can make problems for custom or threaded algorithms or when using custom EdgeFilters for EdgeExplorer creation. Another limitation is that the same edge explorer is used even if a different vehicle/flagEncoder is chosen. Currently we can cache only the ALL_EDGES filter or instances of the DefaultEdgeFilter where three edge explorers will be created: forward OR backward OR both.

enforceHeading

public boolean enforceHeading(int nodeId,
                              double favoredHeading,
                              boolean incoming)

Set those edges at the virtual node (nodeId) to 'unfavored' that require at least a turn of 100° from favoredHeading

Parameters:

nodeId - VirtualNode at which edges get unfavored

favoredHeading - north based azimuth of favored heading between 0 and 360

incoming - if true, incoming edges are unfavored, else outgoing edges

Returns:

boolean indicating if enforcement took place

enforceHeadingByEdgeId

public boolean enforceHeadingByEdgeId(int nodeId,
                                      int edgeId,
                                      boolean incoming)

Set one specific edge at the virtual node with nodeId to 'unfavored' to enforce routing along other edges

Parameters:

nodeId - VirtualNode at which edges get unfavored

edgeId - edge to become unfavored

incoming - if true, incoming edge is unfavored, else outgoing edge

Returns:

boolean indicating if enforcement took place

clearUnfavoredStatus

public void clearUnfavoredStatus()

Removes the 'unfavored' status of all virtual edges.

getNodes

public int getNodes()

Specified by:

getNodes in interface Graph

Returns:

the number of created locations - via setNode() or edge()

getNodeAccess

public NodeAccess getNodeAccess()

Description copied from interface: Graph

Creates a node explorer to access node properties.

Specified by:

getNodeAccess in interface Graph

getBounds

public BBox getBounds()

Description copied from interface: Graph

Returns the implicit bounds of this graph calculated from the lat,lon input of setNode

Specified by:

getBounds in interface Graph

getEdgeIteratorState

public EdgeIteratorState getEdgeIteratorState(int origEdgeId,
                                              int adjNode)

Description copied from interface: Graph

Returns a wrapper over the specified edgeId.

Specified by:

getEdgeIteratorState in interface Graph

adjNode - is the node that will be returned via adjNode(). If adjNode is Integer.MIN_VALUE then the edge with uncertain values for adjNode and baseNode (two possibilities) will be returned.

Returns:

an edge iterator state or potentially null if adjNode does not match

createEdgeExplorer

public EdgeExplorer createEdgeExplorer(EdgeFilter edgeFilter)

Description copied from interface: Graph

Returns an EdgeExplorer which makes it possible to traverse all filtered edges of a specific node. Reduce calling this method as much as possible, e.g. create an explorer before a for loop!

Specified by:

createEdgeExplorer in interface Graph

See Also:

EdgeExplorer, Graph.createEdgeExplorer()

createEdgeExplorer

public EdgeExplorer createEdgeExplorer()

Specified by:

createEdgeExplorer in interface Graph

See Also:

Graph.createEdgeExplorer(com.graphhopper.routing.util.EdgeFilter)

getAllEdges

public AllEdgesIterator getAllEdges()

Specified by:

getAllEdges in interface Graph

Returns:

all edges in this graph, where baseNode will be the smaller node.

edge

public EdgeIteratorState edge(int a,
                              int b)

Description copied from interface: Graph

Creates an edge between the nodes a and b. To set distance or access use the returned edge and e.g. edgeState.setDistance

Specified by:

edge in interface Graph

Parameters:

a - the index of the starting (tower) node of the edge

b - the index of the ending (tower) node of the edge

Returns:

the newly created edge

edge

public EdgeIteratorState edge(int a,
                              int b,
                              double distance,
                              int flags)

edge

public EdgeIteratorState edge(int a,
                              int b,
                              double distance,
                              boolean bothDirections)

Description copied from interface: Graph

Use edge(a,b).setDistance().setFlags instead

Specified by:

edge in interface Graph

copyTo

public Graph copyTo(Graph g)

Description copied from interface: Graph

Copy this Graph into the specified Graph g.

Specified by:

copyTo in interface Graph

Returns:

the specified Graph g

getExtension

public GraphExtension getExtension()

Specified by:

getExtension in interface Graph

Returns:

the graph extension like a TurnCostExtension