com.graphhopper.routing.ch

Class CHAlgoFactoryDecorator

java.lang.Object

com.graphhopper.routing.ch.CHAlgoFactoryDecorator

All Implemented Interfaces:

RoutingAlgorithmFactoryDecorator

public class CHAlgoFactoryDecorator
extends Object
implements RoutingAlgorithmFactoryDecorator

This class implements the CH decorator for the routing algorithm factory and provides several helper methods related to CH preparation and its vehicle profiles.

Author:

Peter Karich

Constructor Summary

Constructors

Constructor and Description
CHAlgoFactoryDecorator()

Method Summary

Modifier and Type	Method and Description
CHAlgoFactoryDecorator	addPreparation(PrepareContractionHierarchies pch)
CHAlgoFactoryDecorator	addWeighting(String weighting)
CHAlgoFactoryDecorator	addWeighting(Weighting weighting) Decouple weightings from PrepareContractionHierarchies as we need weightings for the graphstorage and the graphstorage for the preparation.
void	createPreparations(GraphHopperStorage ghStorage, TraversalMode traversalMode)
RoutingAlgorithmFactory	getDecoratedAlgorithmFactory(RoutingAlgorithmFactory defaultAlgoFactory, HintsMap map) This method returns the specified algoFactory unchanged, decorates it or completely replaces it depending on the specified optionsMap.
TraversalMode	getNodeBase() For now only node based will work, later on we can easily find usage of this method to remove it.
int	getPreparationContractedNodes()
int	getPreparationLazyUpdates()
double	getPreparationLogMessages()
int	getPreparationNeighborUpdates()
int	getPreparationPeriodicUpdates()
List<PrepareContractionHierarchies>	getPreparations()
int	getPreparationThreads()
List<Weighting>	getWeightings()
List<String>	getWeightingsAsStrings()
boolean	hasWeightings()
void	init(CmdArgs args)
boolean	isDisablingAllowed()
boolean	isEnabled()
void	prepare(StorableProperties properties)
CHAlgoFactoryDecorator	setDisablingAllowed(boolean disablingAllowed) This method specifies if it is allowed to disable CH routing at runtime via routing hints.
CHAlgoFactoryDecorator	setEnabled(boolean enabled) Enables or disables contraction hierarchies (CH).
CHAlgoFactoryDecorator	setPreparationContractedNodes(int prepareContractedNodes)
CHAlgoFactoryDecorator	setPreparationLazyUpdates(int prepareLazyUpdates)
CHAlgoFactoryDecorator	setPreparationLogMessages(double prepareLogMessages)
CHAlgoFactoryDecorator	setPreparationNeighborUpdates(int prepareNeighborUpdates)
CHAlgoFactoryDecorator	setPreparationPeriodicUpdates(int preparePeriodicUpdates)
void	setPreparationThreads(int preparationThreads) This method changes the number of threads used for preparation on import.
CHAlgoFactoryDecorator	setWeightingsAsStrings(List<String> weightingList) Enables the use of contraction hierarchies to reduce query times.
CHAlgoFactoryDecorator	setWeightingsAsStrings(String... weightingNames)

Methods inherited from class java.lang.Object

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

Constructor Detail

CHAlgoFactoryDecorator

public CHAlgoFactoryDecorator()

Method Detail

init

public void init(CmdArgs args)

Specified by:

init in interface RoutingAlgorithmFactoryDecorator

getPreparationPeriodicUpdates

public int getPreparationPeriodicUpdates()

setPreparationPeriodicUpdates

public CHAlgoFactoryDecorator setPreparationPeriodicUpdates(int preparePeriodicUpdates)

getPreparationContractedNodes

public int getPreparationContractedNodes()

setPreparationContractedNodes

public CHAlgoFactoryDecorator setPreparationContractedNodes(int prepareContractedNodes)

getPreparationLazyUpdates

public int getPreparationLazyUpdates()

setPreparationLazyUpdates

public CHAlgoFactoryDecorator setPreparationLazyUpdates(int prepareLazyUpdates)

getPreparationLogMessages

public double getPreparationLogMessages()

setPreparationLogMessages

public CHAlgoFactoryDecorator setPreparationLogMessages(double prepareLogMessages)

getPreparationNeighborUpdates

public int getPreparationNeighborUpdates()

setPreparationNeighborUpdates

public CHAlgoFactoryDecorator setPreparationNeighborUpdates(int prepareNeighborUpdates)

isEnabled

public final boolean isEnabled()

Specified by:

isEnabled in interface RoutingAlgorithmFactoryDecorator

setEnabled

public final CHAlgoFactoryDecorator setEnabled(boolean enabled)

Enables or disables contraction hierarchies (CH). This speed-up mode is enabled by default.

isDisablingAllowed

public final boolean isDisablingAllowed()

setDisablingAllowed

public final CHAlgoFactoryDecorator setDisablingAllowed(boolean disablingAllowed)

This method specifies if it is allowed to disable CH routing at runtime via routing hints.

addWeighting

public CHAlgoFactoryDecorator addWeighting(Weighting weighting)

Decouple weightings from PrepareContractionHierarchies as we need weightings for the graphstorage and the graphstorage for the preparation.

addWeighting

public CHAlgoFactoryDecorator addWeighting(String weighting)

addPreparation

public CHAlgoFactoryDecorator addPreparation(PrepareContractionHierarchies pch)

hasWeightings

public final boolean hasWeightings()

getWeightings

public final List<Weighting> getWeightings()

setWeightingsAsStrings

public CHAlgoFactoryDecorator setWeightingsAsStrings(String... weightingNames)

getWeightingsAsStrings

public List<String> getWeightingsAsStrings()

setWeightingsAsStrings

public CHAlgoFactoryDecorator setWeightingsAsStrings(List<String> weightingList)

Enables the use of contraction hierarchies to reduce query times. Enabled by default.

Parameters:

weightingList - A list containing multiple weightings like: "fastest", "shortest" or your own weight-calculation type.

getPreparations

public List<PrepareContractionHierarchies> getPreparations()

getDecoratedAlgorithmFactory

public RoutingAlgorithmFactory getDecoratedAlgorithmFactory(RoutingAlgorithmFactory defaultAlgoFactory,
                                                            HintsMap map)

Description copied from interface: RoutingAlgorithmFactoryDecorator

This method returns the specified algoFactory unchanged, decorates it or completely replaces it depending on the specified optionsMap.

Specified by:

getDecoratedAlgorithmFactory in interface RoutingAlgorithmFactoryDecorator

getPreparationThreads

public int getPreparationThreads()

setPreparationThreads

public void setPreparationThreads(int preparationThreads)

This method changes the number of threads used for preparation on import. Default is 1. Make sure that you have enough memory when increasing this number!

prepare

public void prepare(StorableProperties properties)

createPreparations

public void createPreparations(GraphHopperStorage ghStorage,
                               TraversalMode traversalMode)

getNodeBase

public TraversalMode getNodeBase()

For now only node based will work, later on we can easily find usage of this method to remove it.