Package com.graphhopper.routing.util

Enum Class TraversalMode

java.lang.Object

java.lang.Enum<TraversalMode>

com.graphhopper.routing.util.TraversalMode

All Implemented Interfaces:

Serializable, Comparable<TraversalMode>, Constable

public enum TraversalMode
extends Enum<TraversalMode>

Author:

Peter Karich

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EDGE_BASED
NODE_BASED

Method Summary

Modifier and Type	Method	Description
final int	createTraversalId(RoutingCHEdgeIteratorState chEdgeState, boolean reverse)
final int	createTraversalId(EdgeIteratorState edgeState, boolean reverse)	Returns the identifier to access the map of the shortest path tree according to the traversal mode.
boolean	isEdgeBased()
static TraversalMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TraversalMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NODE_BASED

public static final TraversalMode NODE_BASED

EDGE_BASED

public static final TraversalMode EDGE_BASED

Method Details

values

public static TraversalMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TraversalMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

createTraversalId

public final int createTraversalId(EdgeIteratorState edgeState,
 boolean reverse)

Returns the identifier to access the map of the shortest path tree according to the traversal mode. E.g. returning the adjacent node id in node-based behavior whilst returning the edge id in edge-based behavior

Parameters:

edgeState - the current EdgeIteratorState

reverse - true, if traversal in backward direction. Will be true only for backward searches in bidirectional algorithms.

Returns:

the identifier to access the shortest path tree

createTraversalId

public final int createTraversalId(RoutingCHEdgeIteratorState chEdgeState,
 boolean reverse)

isEdgeBased

public boolean isEdgeBased()