com.graphhopper.util

Interface EdgeIteratorState

All Known Subinterfaces:

AllCHEdgesIterator, AllEdgesIterator, CHEdgeIterator, CHEdgeIteratorState, EdgeIterator

All Known Implementing Classes:

GHUtility.DisabledEdgeIterator, VirtualEdgeIteratorState

public interface EdgeIteratorState

This interface represents an edge and is one possible state of an EdgeIterator.

Author:

Peter Karich

See Also:

EdgeIterator, EdgeExplorer

Field Summary

Fields

Modifier and Type	Field and Description
static int	K_UNFAVORED_EDGE

Method Summary

Modifier and Type	Method and Description
EdgeIteratorState	copyPropertiesTo(EdgeIteratorState e) Copies the properties of this edge into the specified edge.
EdgeIteratorState	detach(boolean reverse) Clones this EdgeIteratorState.
PointList	fetchWayGeometry(int mode) For roadnetwork data like OSM a way is nearly always a curve not just a straight line.
int	getAdditionalField()
int	getAdjNode()
int	getBaseNode() Returns the node used to instantiate the EdgeIterator.
boolean	getBool(int key, boolean _default) Get additional boolean information of the edge.
double	getDistance()
int	getEdge()
long	getFlags()
String	getName()
boolean	isBackward(FlagEncoder encoder)
boolean	isForward(FlagEncoder encoder)
EdgeIteratorState	setAdditionalField(int value) Updates the additional field value for this edge
EdgeIteratorState	setDistance(double dist)
EdgeIteratorState	setFlags(long flags)
EdgeIteratorState	setName(String name)
EdgeIteratorState	setWayGeometry(PointList list)

Field Detail

K_UNFAVORED_EDGE

static final int K_UNFAVORED_EDGE

See Also:

Constant Field Values

Method Detail

getEdge

int getEdge()

Returns:

the edge id of the current edge. Do not make any assumptions about the concrete values, except that for an implementation it is recommended that they'll be contiguous.

getBaseNode

int getBaseNode()

Returns the node used to instantiate the EdgeIterator. Example: "EdgeIterator iter = graph.getEdges(baseNode)". Often only used for convenience reasons. Do not confuse this with a source node of a directed edge.

Returns:

the requested node itself

See Also:

EdgeIterator

getAdjNode

int getAdjNode()

Returns:

the adjacent node of baseNode for the current edge.

See Also:

EdgeIterator

fetchWayGeometry

PointList fetchWayGeometry(int mode)

For roadnetwork data like OSM a way is nearly always a curve not just a straight line. These nodes are called pillar nodes and are between tower nodes (which are used for routing), they are necessary to have a more exact geometry. See the docs for more information (docs/core/low-level-api.md#what-are-pillar-and-tower-nodes). Updates to the returned list are not reflected in the graph, for that you've to use setWayGeometry.

Parameters:

mode - can be

• 0 = only pillar nodes, no tower nodes
• 1 = inclusive the base tower node only
• 2 = inclusive the adjacent tower node only
• 3 = inclusive the base and adjacent tower node

Returns:

pillar nodes

setWayGeometry

EdgeIteratorState setWayGeometry(PointList list)

Parameters:

list - is a sorted collection of nodes between the baseNode and the current adjacent node. Specify the list without the adjacent and base nodes.

getDistance

double getDistance()

Returns:

the distance of the current edge in meter

setDistance

EdgeIteratorState setDistance(double dist)

getFlags

long getFlags()

setFlags

EdgeIteratorState setFlags(long flags)

getAdditionalField

int getAdditionalField()

Returns:

the additional field value for this edge

setAdditionalField

EdgeIteratorState setAdditionalField(int value)

Updates the additional field value for this edge

isForward

boolean isForward(FlagEncoder encoder)

See Also:

and #472

isBackward

boolean isBackward(FlagEncoder encoder)

See Also:

and #472

getBool

boolean getBool(int key,
                boolean _default)

Get additional boolean information of the edge.

Parameters:

key - direction or vehicle dependent integer key

_default - default value if key is not found

getName

String getName()

setName

EdgeIteratorState setName(String name)

detach

EdgeIteratorState detach(boolean reverse)

Clones this EdgeIteratorState.

Parameters:

reverse - if true a detached edgeState with reversed properties is created where base and adjacent nodes, flags and wayGeometry are in reversed order. See #162 for more details about why we need the new reverse parameter.

copyPropertiesTo

EdgeIteratorState copyPropertiesTo(EdgeIteratorState e)

Copies the properties of this edge into the specified edge. Does not change nodes!

Returns:

the specified edge e