com.graphhopper.routing

Class VirtualEdgeIteratorState

java.lang.Object

com.graphhopper.routing.VirtualEdgeIteratorState

All Implemented Interfaces:

CHEdgeIteratorState, EdgeIteratorState

public class VirtualEdgeIteratorState
extends Object
implements EdgeIteratorState, CHEdgeIteratorState

Creates an edge state decoupled from a graph where nodes, pointList, etc are kept in memory.

Note, this class is not suited for public use and can change with minor releases unexpectedly or even gets removed.

Field Summary

Fields inherited from interface com.graphhopper.util.EdgeIteratorState

K_UNFAVORED_EDGE

Constructor Summary

Constructors

Constructor and Description
VirtualEdgeIteratorState(int originalTraversalKey, int edgeId, int baseNode, int adjNode, double distance, long flags, String name, PointList pointList)

Method Summary

Modifier and Type	Method and Description
boolean	canBeOverwritten(long flags) This method is only used on preparation.
EdgeIteratorState	copyPropertiesTo(EdgeIteratorState edge) 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()
int	getOriginalTraversalKey() This method returns the original edge via its traversal key.
int	getSkippedEdge1()
int	getSkippedEdge2()
double	getWeight() Returns the weight of this shortcut.
boolean	isBackward(FlagEncoder encoder)
boolean	isForward(FlagEncoder encoder)
boolean	isShortcut()
EdgeIteratorState	setAdditionalField(int value) Updates the additional field value for this edge
EdgeIteratorState	setDistance(double dist)
EdgeIteratorState	setFlags(long flags)
EdgeIteratorState	setName(String name)
void	setSkippedEdges(int edge1, int edge2) Sets the edges that this shortcut skips.
void	setUnfavored(boolean unfavored) This method sets edge to unfavored status for routing from or to the start/stop points.
EdgeIteratorState	setWayGeometry(PointList list)
CHEdgeIteratorState	setWeight(double weight) Sets the weight calculated from Weighting.calcWeight, only applicable if isShortcut is true.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualEdgeIteratorState

public VirtualEdgeIteratorState(int originalTraversalKey,
                                int edgeId,
                                int baseNode,
                                int adjNode,
                                double distance,
                                long flags,
                                String name,
                                PointList pointList)

Method Detail

getOriginalTraversalKey

public int getOriginalTraversalKey()

This method returns the original edge via its traversal key. I.e. also the direction is already correctly encoded.

See Also:

GHUtility.createEdgeKey(int, int, int, boolean)

getEdge

public int getEdge()

Specified by:

getEdge in interface EdgeIteratorState

Returns:

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

getBaseNode

public int getBaseNode()

Description copied from interface: EdgeIteratorState

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.

Specified by:

getBaseNode in interface EdgeIteratorState

Returns:

the requested node itself

See Also:

EdgeIterator

getAdjNode

public int getAdjNode()

Specified by:

getAdjNode in interface EdgeIteratorState

Returns:

the adjacent node of baseNode for the current edge.

See Also:

EdgeIterator

fetchWayGeometry

public PointList fetchWayGeometry(int mode)

Description copied from interface: EdgeIteratorState

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.

Specified by:

fetchWayGeometry in interface EdgeIteratorState

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

public EdgeIteratorState setWayGeometry(PointList list)

Specified by:

setWayGeometry in interface EdgeIteratorState

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

public double getDistance()

Specified by:

getDistance in interface EdgeIteratorState

Returns:

the distance of the current edge in meter

setDistance

public EdgeIteratorState setDistance(double dist)

Specified by:

setDistance in interface EdgeIteratorState

getFlags

public long getFlags()

Specified by:

getFlags in interface EdgeIteratorState

setFlags

public EdgeIteratorState setFlags(long flags)

Specified by:

setFlags in interface EdgeIteratorState

getName

public String getName()

Specified by:

getName in interface EdgeIteratorState

setName

public EdgeIteratorState setName(String name)

Specified by:

setName in interface EdgeIteratorState

getBool

public boolean getBool(int key,
                       boolean _default)

Description copied from interface: EdgeIteratorState

Get additional boolean information of the edge.

Specified by:

getBool in interface EdgeIteratorState

Parameters:

key - direction or vehicle dependent integer key

_default - default value if key is not found

setUnfavored

public void setUnfavored(boolean unfavored)

This method sets edge to unfavored status for routing from or to the start/stop points.

toString

public String toString()

Overrides:

toString in class Object

isShortcut

public boolean isShortcut()

Specified by:

isShortcut in interface CHEdgeIteratorState

Returns:

true if this edge is a shortcut, false otherwise.

isForward

public boolean isForward(FlagEncoder encoder)

Specified by:

isForward in interface EdgeIteratorState

See Also:

and #472

isBackward

public boolean isBackward(FlagEncoder encoder)

Specified by:

isBackward in interface EdgeIteratorState

See Also:

and #472

getAdditionalField

public int getAdditionalField()

Specified by:

getAdditionalField in interface EdgeIteratorState

Returns:

the additional field value for this edge

canBeOverwritten

public boolean canBeOverwritten(long flags)

Description copied from interface: CHEdgeIteratorState

This method is only used on preparation.

Specified by:

canBeOverwritten in interface CHEdgeIteratorState

See Also:

PrepareEncoder.canBeOverwritten(long, long)

getSkippedEdge1

public int getSkippedEdge1()

Specified by:

getSkippedEdge1 in interface CHEdgeIteratorState

getSkippedEdge2

public int getSkippedEdge2()

Specified by:

getSkippedEdge2 in interface CHEdgeIteratorState

setSkippedEdges

public void setSkippedEdges(int edge1,
                            int edge2)

Description copied from interface: CHEdgeIteratorState

Sets the edges that this shortcut skips. Those skipped edges can be shortcuts too.

Specified by:

setSkippedEdges in interface CHEdgeIteratorState

detach

public EdgeIteratorState detach(boolean reverse)

Description copied from interface: EdgeIteratorState

Clones this EdgeIteratorState.

Specified by:

detach in interface 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.

setAdditionalField

public EdgeIteratorState setAdditionalField(int value)

Description copied from interface: EdgeIteratorState

Updates the additional field value for this edge

Specified by:

setAdditionalField in interface EdgeIteratorState

copyPropertiesTo

public EdgeIteratorState copyPropertiesTo(EdgeIteratorState edge)

Description copied from interface: EdgeIteratorState

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

Specified by:

copyPropertiesTo in interface EdgeIteratorState

Returns:

the specified edge e

setWeight

public CHEdgeIteratorState setWeight(double weight)

Description copied from interface: CHEdgeIteratorState

Sets the weight calculated from Weighting.calcWeight, only applicable if isShortcut is true.

Specified by:

setWeight in interface CHEdgeIteratorState

getWeight

public double getWeight()

Description copied from interface: CHEdgeIteratorState

Returns the weight of this shortcut.

Specified by:

getWeight in interface CHEdgeIteratorState