ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.routing.routingalgorithm
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.Routing.RoutingAlgorithm
This class is the base class for all types of RoutingAlgorithm.
Remarks
The RoutingAlgorithm class is where all other types of RoutingAlgorithm are inherited from. It provides the base set of functionality.As it is abstract, you will need to implement the GetRouteCore method. In this method, you are repsonsible for implementing a routing algorithm to get the path between two routeSegments.There are many graph search algorithms you can use to extend this class. This assembly includes Dijkstra, A* and Bidirectional, but you can also write your own.
Inheritance Hierarchy
- System.Object
-
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 RoutingAlgorithm | This is the default constructor for the RoutingAlgorithm and should be called by inherited classes. |
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Equals | Object | Object | |
| GetHashCode | Object | ||
| GetRoute | RoutingSource, String, String | This method returns a RoutingResult based on the extent you provided. | |
| GetType | Object | ||
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| Finalize | Object | ||
| GetRouteCore | RoutingSource, String, String | This method returns a RoutingResult based on the extent you provided. | |
| MemberwiseClone | Object | ||
| OnFindingRoute | FindingRouteRoutingAlgorithmEventArgs | This method allows you to raise the FindingRoute event from a derived class. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 DistanceUnit | DistanceUnit | ||
| GeographyUnit | GeographyUnit |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|---|---|---|
 FindingRoute | FindingRouteRoutingAlgorithmEventArgs | This event is called after finding the adjacent routeSegments. |
Public Constructors
Protected Constructors
RoutingAlgorithm()
This is the default constructor for the RoutingAlgorithm and should be called by inherited classes.
Remarks
This is the default constructor for the RoutingAlgorithm and should be called by inherited classes.
Parameters
| Name | Type | Description |
|---|
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.RoutingAlgorithm#Equals.28Object.29
Return Value
| Return Type | Description |
|---|---|
| Boolean |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object |
GetHashCode()
Remarks
For the most updated Info for this topic, please check it here: http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#GetHashCode.28.29
Return Value
| Return Type | Description |
|---|---|
| Int32 |
Parameters
| Name | Type | Description |
|---|
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> | Routing result that contains path information. |
Parameters
| Name | Type | Description |
|---|---|---|
| routingSource | RoutingSource | The routing source that contains the routeSegments to route on. |
| startFeatureId | String | The feature ID which represents the starting routeSegment. |
| endFeatureId | String | The feature ID which represents the ending routeSegment. |
GetType()
Remarks
For the most updated Info for this topic, please check it here: http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#GetType.28.29
Return Value
| Return Type | Description |
|---|---|
| Type |
Parameters
| Name | Type | Description |
|---|
ToString()
Remarks
For the most updated Info for this topic, please check it here: http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#ToString.28.29
Return Value
| Return Type | Description |
|---|---|
| String |
Parameters
| Name | Type | Description |
|---|
Protected Methods
Finalize()
Remarks
For the most updated Info for this topic, please check it here: http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#Finalize.28.29
Return Value
| Return Type | Description |
|---|---|
| Void |
Parameters
| Name | Type | Description |
|---|
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> | Routing result that contains path information. |
Parameters
| Name | Type | Description |
|---|---|---|
| routingSource | RoutingSource | The routing source that contains the routeSegments to route on. |
| startFeatureId | String | The feature ID which represents the starting routeSegment. |
| endFeatureId | String | The feature ID which represents the ending routeSegment. |
MemberwiseClone()
Remarks
For the most updated Info for this topic, please check it here: http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#MemberwiseClone.28.29
Return Value
| Return Type | Description |
|---|---|
| Object |
Parameters
| Name | Type | Description |
|---|
OnFindingRoute(FindingRouteRoutingAlgorithmEventArgs)
This method allows you to raise the FindingRoute event from a derived class.
Remarks
For the most updated Info for this topic, please check it here: http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#OnFindingRoute.28FindingRouteRoutingAlgorithmEventArgs.29
Return Value
| Return Type | Description |
|---|---|
| Void |
Parameters
| Name | Type | Description |
|---|---|---|
| e | FindingRouteRoutingAlgorithmEventArgs |
Public Properties
DistanceUnit
Remarks
For the most updated Info for this topic, please check it here: http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#DistanceUnit
Return Value
| Return Type |
|---|
| DistanceUnit |
GeographyUnit
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#GeographyUnit” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#GeographyUnit</a>
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.routingalgorithm.1441941662.txt.gz · Last modified: 2015/09/11 03:21 by admin