TGIS_ShortestPath class

Encapsulates shortest path and routing functionality over a vector network.

Syntax

# Python
class TGIS_ShortestPath( Object ):

→ Object

Inherited Overrides Protected

	Name	Visibility	Description
	__init__	public	Create an instance.

Inherited Overrides Protected

Name	Visibility	Description
Find	public	Find a path between two positions.
LoadTheData	public	Load data from the layer and, on first use, create persistent storage files for the network.
Regenerate	public	Recreate network (including network storage files).
StartPos	public	Set a start position for the shortest path.
StopPos	public	Set a stop position for the shortest path and run path calculation.
UpdateTheData	public	Update the network with geocoded addresses from the geocoder.

Inherited Protected

Name	Visibility	Description
CompassBlocks	public	Compass divided into a number of blocks (4 by default).
CostModifiers	public	Cost modifier for a link type.
Extent	public	Extent of the whole path.
HeuristicCostModifier	public	Cost modifier for heuristic cost calculation.
HeuristicMode	public	Mode of heuristic operation.
HeuristicThreshold	public	Threshold of the starting node search area.
Items	public	Items in the shortest path.
ItemsCount	public	Number of items in the shortest path.
Layer	public	Layer assigned to the shortest path.
Network	public	Network instance responsible for low-level network operations.
OSMRouting	public	If True, the local routing resource is ignored and requests are sent to the TatukGIS online routing service.
RoadLength	public	Field name used to calculate segment length.
RoadName	public	Field for the feature name.
StoragePath	public	Forced network storage path.
TotalCost	public	Total cost of the path.

Inherited Protected

Name	Visibility	Description
LinkCostEvent	published	Event fired when link cost is obtained while building the network.
LinkDynamicEvent	published	Event which will be fired upon traversing link.
LinkLevelEvent	published	Event fired when the ending node levels of each link are obtained.
LinkTypeEvent	published	Event fired when the type of each link is obtained while building the network.
NodeHeuristicCostEvent	published	Event fired when heuristic cost is calculated for a node.
PathEvent	published	Event which will be fired on each link of the discovered shortest path.