com.graphhopper.storage

Class TurnCostExtension

java.lang.Object

com.graphhopper.storage.TurnCostExtension

All Implemented Interfaces:

GraphExtension, Storable<GraphExtension>, Closeable, AutoCloseable

public class TurnCostExtension
extends Object
implements GraphExtension

Holds turn cost tables for each node. The additional field of a node will be used to point towards the first entry within a node cost table to identify turn restrictions, or later, turn getCosts.

Author:

Karl Hübner, Peter Karich

Nested Class Summary

Nested classes/interfaces inherited from interface com.graphhopper.storage.GraphExtension

GraphExtension.NoOpExtension

Constructor Summary

Constructors

Constructor and Description
TurnCostExtension()

Method Summary

Modifier and Type	Method and Description
void	addTurnInfo(int fromEdge, int viaNode, int toEdge, long turnFlags) Add an entry which is a turn restriction or cost information via the turnFlags.
void	close() This method makes sure that the underlying used resources are released.
GraphExtension	copyTo(GraphExtension clonedStorage) creates a copy of this extended storage
TurnCostExtension	create(long initBytes) Creates the underlying storage.
void	flush() This method makes sure that the underlying data is written to the storage.
long	getCapacity()
int	getDefaultEdgeFieldValue()
int	getDefaultNodeFieldValue()
long	getTurnCostFlags(int edgeFrom, int nodeVia, int edgeTo)
void	init(Graph graph, Directory dir) initializes the extended storage by giving the base graph
boolean	isClosed()
boolean	isRequireEdgeField()
boolean	isRequireNodeField()
boolean	loadExisting()
void	mergeOrOverwriteTurnInfo(int fromEdge, int viaNode, int toEdge, long turnFlags, boolean merge) Add a new turn cost entry or clear an existing.
void	setSegmentSize(int bytes) sets the segment size in all additional data storages
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TurnCostExtension

public TurnCostExtension()

Method Detail

init

public void init(Graph graph,
                 Directory dir)

Description copied from interface: GraphExtension

initializes the extended storage by giving the base graph

Specified by:

init in interface GraphExtension

setSegmentSize

public void setSegmentSize(int bytes)

Description copied from interface: GraphExtension

sets the segment size in all additional data storages

Specified by:

setSegmentSize in interface GraphExtension

create

public TurnCostExtension create(long initBytes)

Description copied from interface: Storable

Creates the underlying storage. First operation if it cannot be loaded.

Specified by:

create in interface Storable<GraphExtension>

flush

public void flush()

Description copied from interface: Storable

This method makes sure that the underlying data is written to the storage. Keep in mind that a disc normally has an IO cache so that flush() is (less) probably not save against power loses.

Specified by:

flush in interface Storable<GraphExtension>

close

public void close()

Description copied from interface: Storable

This method makes sure that the underlying used resources are released. WARNING: it does NOT flush on close!

Specified by:

close in interface Storable<GraphExtension>

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getCapacity

public long getCapacity()

Specified by:

getCapacity in interface Storable<GraphExtension>

Returns:

the allocated storage size in bytes

loadExisting

public boolean loadExisting()

Specified by:

loadExisting in interface Storable<GraphExtension>

Returns:

true if successfully loaded from persistent storage.

addTurnInfo

public void addTurnInfo(int fromEdge,
                        int viaNode,
                        int toEdge,
                        long turnFlags)

Add an entry which is a turn restriction or cost information via the turnFlags. Overwrite existing information if it is the same edges and node.

mergeOrOverwriteTurnInfo

public void mergeOrOverwriteTurnInfo(int fromEdge,
                                     int viaNode,
                                     int toEdge,
                                     long turnFlags,
                                     boolean merge)

Add a new turn cost entry or clear an existing. See TurnFlagsReadWriteTest for usage examples.

Parameters:

fromEdge - edge ID

viaNode - node ID

toEdge - edge ID

turnFlags - flags to be written

merge - If true don't overwrite existing entries with the new flag but do a bitwise OR of the old and new flags and write this merged flag.

getTurnCostFlags

public long getTurnCostFlags(int edgeFrom,
                             int nodeVia,
                             int edgeTo)

Returns:

turn flags of the specified node and edge properties.

isRequireNodeField

public boolean isRequireNodeField()

Specified by:

isRequireNodeField in interface GraphExtension

Returns:

true, if and only if an additional field at the graphs node storage is required

isRequireEdgeField

public boolean isRequireEdgeField()

Specified by:

isRequireEdgeField in interface GraphExtension

Returns:

true, if and only if an additional field at the graphs edge storage is required

getDefaultNodeFieldValue

public int getDefaultNodeFieldValue()

Specified by:

getDefaultNodeFieldValue in interface GraphExtension

Returns:

the default field value which will be set for default when creating nodes

getDefaultEdgeFieldValue

public int getDefaultEdgeFieldValue()

Specified by:

getDefaultEdgeFieldValue in interface GraphExtension

Returns:

the default field value which will be set for default when creating edges

copyTo

public GraphExtension copyTo(GraphExtension clonedStorage)

Description copied from interface: GraphExtension

creates a copy of this extended storage

Specified by:

copyTo in interface GraphExtension

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Storable<GraphExtension>

toString

public String toString()

Overrides:

toString in class Object