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

REVERSE_STATE, UNFAVORED_EDGE

Constructor Summary

Constructors

Constructor and Description
VirtualEdgeIteratorState(int originalEdgeKey, int edgeId, int baseNode, int adjNode, double distance, IntsRef edgeFlags, String name, PointList pointList, boolean reverse)

Method Summary

Modifier and Type	Method and Description
EdgeIteratorState	copyPropertiesFrom(EdgeIteratorState fromEdge) Copies the properties of the specified edge into this edge.
EdgeIteratorState	detach(boolean reverse) Clones this EdgeIteratorState.
PointList	fetchWayGeometry(int mode) For road network data like OSM a way is nearly always a curve not just a straight line.
boolean	get(BooleanEncodedValue property)
double	get(DecimalEncodedValue property)
<T extends Enum> T	get(EnumEncodedValue<T> property)
int	get(IntEncodedValue property)
int	getAdditionalField()
int	getAdjNode()
int	getBaseNode() Returns the node used to instantiate the EdgeIterator.
double	getDistance()
int	getEdge()
IntsRef	getFlags() Returns edge properties stored in direction of the raw database layout.
int	getMergeStatus(int flags) This method is only used on preparation.
String	getName()
int	getOrigEdgeFirst()
int	getOrigEdgeLast()
int	getOriginalEdgeKey() This method returns the original edge via its key.
boolean	getReverse(BooleanEncodedValue property)
double	getReverse(DecimalEncodedValue property)
<T extends Enum> T	getReverse(EnumEncodedValue<T> property)
int	getReverse(IntEncodedValue property)
int	getSkippedEdge1()
int	getSkippedEdge2()
double	getWeight() Returns the weight of this shortcut.
boolean	isShortcut()
EdgeIteratorState	set(BooleanEncodedValue property, boolean value)
EdgeIteratorState	set(DecimalEncodedValue property, double value)
<T extends Enum> EdgeIteratorState	set(EnumEncodedValue<T> property, T value)
EdgeIteratorState	set(IntEncodedValue property, int value)
EdgeIteratorState	setAdditionalField(int value) Updates the additional field value for this edge
EdgeIteratorState	setDistance(double dist)
CHEdgeIteratorState	setFirstAndLastOrigEdges(int firstOrigEdge, int lastOrigEdge) Sets the first and last original edges that are skipped by this shortcut.
EdgeIteratorState	setFlags(IntsRef flags) Stores the specified edgeFlags down to the DataAccess
void	setFlagsAndWeight(int flags, double weight)
EdgeIteratorState	setName(String name)
EdgeIteratorState	setReverse(BooleanEncodedValue property, boolean value)
EdgeIteratorState	setReverse(DecimalEncodedValue property, double value)
<T extends Enum> EdgeIteratorState	setReverse(EnumEncodedValue<T> property, T value)
EdgeIteratorState	setReverse(IntEncodedValue property, int value)
void	setReverseEdge(EdgeIteratorState reverseEdge)
CHEdgeIteratorState	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 the start or to the stop location.
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 originalEdgeKey,
                                int edgeId,
                                int baseNode,
                                int adjNode,
                                double distance,
                                IntsRef edgeFlags,
                                String name,
                                PointList pointList,
                                boolean reverse)

Method Detail

getOriginalEdgeKey

public int getOriginalEdgeKey()

This method returns the original edge via its 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 implementation 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 road network 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 base node and the current adjacent node. Specify the list without the adjacent and base node. This method can be called multiple times, but if the distance changes, the setDistance method is not called automatically.

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 IntsRef getFlags()

Description copied from interface: EdgeIteratorState

Returns edge properties stored in direction of the raw database layout. So do not use it directly, instead use the appropriate set/get methods with its EncodedValue object.

Specified by:

getFlags in interface EdgeIteratorState

setFlags

public EdgeIteratorState setFlags(IntsRef flags)

Description copied from interface: EdgeIteratorState

Stores the specified edgeFlags down to the DataAccess

Specified by:

setFlags in interface EdgeIteratorState

get

public boolean get(BooleanEncodedValue property)

Specified by:

get in interface EdgeIteratorState

set

public EdgeIteratorState set(BooleanEncodedValue property,
                             boolean value)

Specified by:

set in interface EdgeIteratorState

getReverse

public boolean getReverse(BooleanEncodedValue property)

Specified by:

getReverse in interface EdgeIteratorState

setReverse

public EdgeIteratorState setReverse(BooleanEncodedValue property,
                                    boolean value)

Specified by:

setReverse in interface EdgeIteratorState

get

public int get(IntEncodedValue property)

Specified by:

get in interface EdgeIteratorState

set

public EdgeIteratorState set(IntEncodedValue property,
                             int value)

Specified by:

set in interface EdgeIteratorState

getReverse

public int getReverse(IntEncodedValue property)

Specified by:

getReverse in interface EdgeIteratorState

setReverse

public EdgeIteratorState setReverse(IntEncodedValue property,
                                    int value)

Specified by:

setReverse in interface EdgeIteratorState

get

public double get(DecimalEncodedValue property)

Specified by:

get in interface EdgeIteratorState

set

public EdgeIteratorState set(DecimalEncodedValue property,
                             double value)

Specified by:

set in interface EdgeIteratorState

getReverse

public double getReverse(DecimalEncodedValue property)

Specified by:

getReverse in interface EdgeIteratorState

setReverse

public EdgeIteratorState setReverse(DecimalEncodedValue property,
                                    double value)

Specified by:

setReverse in interface EdgeIteratorState

get

public <T extends Enum> T get(EnumEncodedValue<T> property)

Specified by:

get in interface EdgeIteratorState

set

public <T extends Enum> EdgeIteratorState set(EnumEncodedValue<T> property,
                                              T value)

Specified by:

set in interface EdgeIteratorState

getReverse

public <T extends Enum> T getReverse(EnumEncodedValue<T> property)

Specified by:

getReverse in interface EdgeIteratorState

setReverse

public <T extends Enum> EdgeIteratorState setReverse(EnumEncodedValue<T> property,
                                                     T value)

Specified by:

setReverse 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

setUnfavored

public void setUnfavored(boolean unfavored)

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

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.

getAdditionalField

public int getAdditionalField()

Specified by:

getAdditionalField in interface EdgeIteratorState

Returns:

the additional field value for this edge

getMergeStatus

public int getMergeStatus(int flags)

Description copied from interface: CHEdgeIteratorState

This method is only used on preparation.

Specified by:

getMergeStatus in interface CHEdgeIteratorState

See Also:

PrepareEncoder.getScMergeStatus(int, int)

getSkippedEdge1

public int getSkippedEdge1()

Specified by:

getSkippedEdge1 in interface CHEdgeIteratorState

getSkippedEdge2

public int getSkippedEdge2()

Specified by:

getSkippedEdge2 in interface CHEdgeIteratorState

setSkippedEdges

public CHEdgeIteratorState 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

setFirstAndLastOrigEdges

public CHEdgeIteratorState setFirstAndLastOrigEdges(int firstOrigEdge,
                                                    int lastOrigEdge)

Description copied from interface: CHEdgeIteratorState

Sets the first and last original edges that are skipped by this shortcut. For example for the following shortcut edge from x to y, which itself skips the shortcuts x->v and v->y the first original edge would be x->u and the last original edge would be w->y

x --> u --> v --> w --> y

Specified by:

setFirstAndLastOrigEdges in interface CHEdgeIteratorState

getOrigEdgeFirst

public int getOrigEdgeFirst()

Specified by:

getOrigEdgeFirst in interface EdgeIteratorState

Returns:

the edge id of the first original edge of the current edge. This is needed for shortcuts in edge-based contraction hierarchies and otherwise simply returns the id of the current edge.

getOrigEdgeLast

public int getOrigEdgeLast()

Specified by:

getOrigEdgeLast in interface EdgeIteratorState

See Also:

EdgeIteratorState.getOrigEdgeFirst()

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 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

copyPropertiesFrom

public EdgeIteratorState copyPropertiesFrom(EdgeIteratorState fromEdge)

Description copied from interface: EdgeIteratorState

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

Specified by:

copyPropertiesFrom 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

setFlagsAndWeight

public void setFlagsAndWeight(int flags,
                              double weight)

Specified by:

setFlagsAndWeight in interface CHEdgeIteratorState

getWeight

public double getWeight()

Description copied from interface: CHEdgeIteratorState

Returns the weight of this shortcut.

Specified by:

getWeight in interface CHEdgeIteratorState

setReverseEdge

public void setReverseEdge(EdgeIteratorState reverseEdge)