com.graphhopper.util

Interface EdgeIterator

All Superinterfaces:

EdgeIteratorState

All Known Subinterfaces:

AllCHEdgesIterator, AllEdgesIterator, CHEdgeIterator

All Known Implementing Classes:

GHUtility.DisabledEdgeIterator

public interface EdgeIterator
extends EdgeIteratorState

Iterates through all edges of one node. Avoids object creation in-between via direct access methods. If you want to access some properties of an 'edge' (i.e. the current state) for later usage store it via edgeIterator.detach() or edgeIterator.getEdge() instead of the iterator itself. Usage:

 EdgeExplorer explorer = graph.createEdgeExplorer();
 EdgeIterator iter = explorer.setBaseNode(nodeId);
 // calls to iter.getAdjNode(), getDistance() without calling next() will cause undefined behaviour!
 while(iter.next()) {
   int baseNodeId = iter.getBaseNode(); // equal to nodeId
   int adjacentNodeId = iter.getAdjNode(); // this is the node where this edge state is "pointing to"
   ...
 }
 

Author:

Peter Karich

See Also:

EdgeIteratorState, EdgeExplorer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EdgeIterator.Edge

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_EDGE integer value to indicate if an edge is valid or not which then would be initialized with this value

Fields inherited from interface com.graphhopper.util.EdgeIteratorState

K_UNFAVORED_EDGE

Method Summary

Modifier and Type	Method and Description
boolean	next() To be called to go to the next edge state.

Methods inherited from interface com.graphhopper.util.EdgeIteratorState

copyPropertiesTo, detach, fetchWayGeometry, getAdditionalField, getAdjNode, getBaseNode, getBool, getDistance, getEdge, getFlags, getName, isBackward, isForward, setAdditionalField, setDistance, setFlags, setName, setWayGeometry

Field Detail

NO_EDGE

static final int NO_EDGE

integer value to indicate if an edge is valid or not which then would be initialized with this value

See Also:

Constant Field Values

Method Detail

next

boolean next()

To be called to go to the next edge state.

Returns:

true if an edge state is available