com.graphhopper.storage

Class TurnCostStorage

java.lang.Object

com.graphhopper.storage.TurnCostStorage

All Implemented Interfaces:

Storable<TurnCostStorage>, Closeable, AutoCloseable

public class TurnCostStorage
extends Object
implements Storable<TurnCostStorage>

A key/value store, where the unique keys are turn relations, and the values are IntRefs. A turn relation is a triple (fromEdge, viaNode, toEdge), and refers to one of the possible ways of crossing an intersection.

Like IntRefs on edges, this can in principle be used to store values of any kind.

In practice, the IntRefs are used to store generalized travel costs per turn relation per vehicle type. In practice, we only store 0 or infinity. (Can turn, or cannot turn.)

Author:

Karl Hübner, Peter Karich, Michael Zilske

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TurnCostStorage.TurnRelationIterator

Constructor Summary

Constructors

Constructor and Description
TurnCostStorage(com.graphhopper.storage.BaseGraph baseGraph, DataAccess turnCosts)

Method Summary

Modifier and Type	Method and Description
void	close() This method makes sure that the underlying used resources are released.
TurnCostStorage	copyTo(TurnCostStorage turnCostStorage)
TurnCostStorage	create(long initBytes) Creates the underlying storage.
void	flush() This method makes sure that the underlying data is written to the storage.
double	get(DecimalEncodedValue turnCostEnc, int fromEdge, int viaNode, int toEdge)
TurnCostStorage.TurnRelationIterator	getAllTurnRelations() Returns an iterator over all entries.
long	getCapacity()
boolean	isClosed()
boolean	loadExisting()
void	set(DecimalEncodedValue turnCostEnc, int fromEdge, int viaNode, int toEdge, double cost) Sets the turn cost at the viaNode when going from "fromEdge" to "toEdge" WARNING: It is tacitly assumed that for every encoder, this method is only called once per turn relation.
void	setSegmentSize(int bytes)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TurnCostStorage

public TurnCostStorage(com.graphhopper.storage.BaseGraph baseGraph,
                       DataAccess turnCosts)

Method Detail

setSegmentSize

public void setSegmentSize(int bytes)

create

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

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

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

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getCapacity

public long getCapacity()

Specified by:

getCapacity in interface Storable<TurnCostStorage>

Returns:

the allocated storage size in bytes

loadExisting

public boolean loadExisting()

Specified by:

loadExisting in interface Storable<TurnCostStorage>

Returns:

true if successfully loaded from persistent storage.

set

public void set(DecimalEncodedValue turnCostEnc,
                int fromEdge,
                int viaNode,
                int toEdge,
                double cost)

Sets the turn cost at the viaNode when going from "fromEdge" to "toEdge" WARNING: It is tacitly assumed that for every encoder, this method is only called once per turn relation. Subsequent calls for the same encoder and the same turn relation will have undefined results. (The implementation below ORs the new bits into the existing bits.)

get

public double get(DecimalEncodedValue turnCostEnc,
                  int fromEdge,
                  int viaNode,
                  int toEdge)

Returns:

the turn cost of the viaNode when going from "fromEdge" to "toEdge"

copyTo

public TurnCostStorage copyTo(TurnCostStorage turnCostStorage)

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Storable<TurnCostStorage>

toString

public String toString()

Overrides:

toString in class Object

getAllTurnRelations

public TurnCostStorage.TurnRelationIterator getAllTurnRelations()

Returns an iterator over all entries.

Returns:

an iterator over all entries.