User Tools

Site Tools


thinkgeo.mapsuite.routing.astarroutingalgorithm

This is an old revision of the document!


ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm

This class represents a routing algorithm that is based on the A* algorithm.

Remarks

The A* algorithm is one of the best graph search algorithms that finds the least-cost path from a given start point to a given end point. It uses a distance-plus-cost heuristic function to determine the order in which the search visits routeSegments in the data.

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodAStarRoutingAlgorithm This is a constructor for this class.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodEquals Object Object
Public MethodGetHashCode Object
Public MethodGetRoute RoutingSource, String, String RoutingAlgorithm This method returns a RoutingResult based on the extent you provided.
Public MethodGetType Object
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodFinalize Object
Protected MethodGetRouteCore RoutingSource, String, String RoutingAlgorithm(overriden) This method returns a RoutingResult based on the extent you provided.
Protected MethodMemberwiseClone Object
Protected MethodOnFindingRoute FindingRouteRoutingAlgorithmEventArgs RoutingAlgorithm This method allows you to raise the FindingRoute event from a derived class.

Public Properties

Protected Properties

Name Return DeclaringType Summary

Public Events

Name Event Arguments DeclaringType Summary
Public EventFindingRoute FindingRouteRoutingAlgorithmEventArgs RoutingAlgorithm This event is called after finding the adjacent routeSegments.

Public Constructors

AStarRoutingAlgorithm()

This is a constructor for this class.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#AStarRoutingAlgorithm.28.29

Parameters

Name Type Description

Go Back

Protected Constructors

Public Methods

Equals(Object)

Remarks

For the most updated Info for this topic, please check it here: http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#Equals.28Object.29

Return Value

Return Type Description
Boolean

Parameters

Name Type Description
obj Object

Go Back

GetHashCode()

Remarks

For the most updated Info for this topic, please check it here: http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#GetHashCode.28.29

Return Value

Return Type Description
Int32

Parameters

Name Type Description

Go Back

GetRoute(RoutingSource, String, String)

This method returns a RoutingResult based on the extent you provided.

Remarks

This method is the concrete wrapper for the abstract method GetRouteCore.This method gets the routing result based on the extent you provided. In this method, you are repsonsible for implementing a routing algorithm to get the path between two routeSegments.

Return Value

Return Type Description
Collection<RouteSegment><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Routing.RouteSegment} –> Routing result that contains path information.

Parameters

Name Type Description
routingSource RoutingSource<!– ThinkGeo.MapSuite.Routing.RoutingSource –> The routing source that contains the routeSegments to route on.
startFeatureId String<!– System.String –> The feature ID which represents the starting routeSegment.
endFeatureId String<!– System.String –> The feature ID which represents the ending routeSegment.

<!– ThinkGeo.MapSuite.Routing.RoutingAlgorithm –> Go Back

GetType()

Remarks

Return Value

Return Type Description
Type<!– System.Type –>

Parameters

Name Type Description

<!– System.Object –> Go Back

ToString()

Remarks

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

Finalize()

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetRouteCore(RoutingSource, String, String)

This method returns a RoutingResult based on the extent you provided.

Remarks

This abstract method is called from the concrete public method GetRoute.This method gets the routing result based on the extent you provided. In this method, you are repsonsible for implementing a routing algorithm to get the path between two routeSegments.

Return Value

Return Type Description
Collection<RouteSegment><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Routing.RouteSegment} –> Routing result that contains path information.

Parameters

Name Type Description
routingSource RoutingSource<!– ThinkGeo.MapSuite.Routing.RoutingSource –> The routing source that contains the routeSegments to route on.
startFeatureId String<!– System.String –> The feature ID which represents the starting routeSegment.
endFeatureId String<!– System.String –> The feature ID which represents the ending routeSegment.

<!– ThinkGeo.MapSuite.Routing.RoutingAlgorithm(overriden) –> Go Back

MemberwiseClone()

Remarks

Return Value

Return Type Description
Object<!– System.Object –>

Parameters

Name Type Description

<!– System.Object –> Go Back

OnFindingRoute(FindingRouteRoutingAlgorithmEventArgs)

This method allows you to raise the FindingRoute event from a derived class.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e FindingRouteRoutingAlgorithmEventArgs<!– ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs –>

<!– ThinkGeo.MapSuite.Routing.RoutingAlgorithm –> Go Back

Public Properties

AStartRouteModifier

Remarks

Return Value

Return Type
Single<!– System.Single –>

<!– ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm –> Go Back

DistanceUnit

Remarks

Return Value

Return Type
DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –>

<!– ThinkGeo.MapSuite.Routing.RoutingAlgorithm –> Go Back

GeographyUnit

Remarks

Return Value

Return Type
GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –>

<!– ThinkGeo.MapSuite.Routing.RoutingAlgorithm –> Go Back

Protected Properties

Public Events

FindingRoute

This event is called after finding the adjacent routeSegments.

Remarks

This event is called after finding the adjacent routeSegments. It wil be called many times during the route.

Event Arguments

Event Arguments
FindingRouteRoutingAlgorithmEventArgs<!– ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs –>

<!– ThinkGeo.MapSuite.Routing.RoutingAlgorithm –> Go Back

NOTOC MapSuiteRouting ThinkGeo.MapSuite.Routing UpdateDocumentation

thinkgeo.mapsuite.routing.astarroutingalgorithm.1441939053.txt.gz · Last modified: 2015/09/11 02:37 by admin