thinkgeo.mapsuite.routing.dijkstraroutingalgorithm
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.routing.dijkstraroutingalgorithm [2015/09/18 03:06] admin |
thinkgeo.mapsuite.routing.dijkstraroutingalgorithm [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm ====== | ====== ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class represents a routing algorithm that is based on the Dijkstra algorithm. | This class represents a routing algorithm that is based on the Dijkstra algorithm. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 9: | Line 12: | ||
| ** {{wiki:PublicMethod.gif|}} DijkstraRoutingAlgorithm() ** | ** {{wiki:PublicMethod.gif|}} DijkstraRoutingAlgorithm() ** | ||
| - | This is a constructor for this class. | + | * //This is a constructor for this class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm#DijkstraRoutingAlgorithm.28.29// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| Line 18: | Line 21: | ||
| ** {{wiki:PublicMethod.gif|}} GetRoute(RoutingSource,String,String) ** | ** {{wiki:PublicMethod.gif|}} GetRoute(RoutingSource,String,String) ** | ||
| - | N/A | + | * //This method returns a RoutingResult based on the extent you provided.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 Value == | ||
| * Type:Collection<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]> | * Type:Collection<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]> | ||
| - | * Description:N/A | + | * Description:Routing result that contains path information. |
| == Parameters == | == Parameters == | ||
| * //routingSource// | * //routingSource// | ||
| * Type:[[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]] | * Type:[[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]] | ||
| - | * Description:N/A | + | * Description:The routing source that contains the routeSegments to route on. |
| * //startFeatureId// | * //startFeatureId// | ||
| * Type:String | * Type:String | ||
| - | * Description:N/A | + | * Description:The feature ID which represents the starting routeSegment. |
| * //endFeatureId// | * //endFeatureId// | ||
| * Type:String | * Type:String | ||
| - | * Description:N/A | + | * Description:The feature ID which represents the ending routeSegment. |
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm#ToString.28.29// |
| == Return Value == | == Return Value == | ||
| Line 54: | Line 57: | ||
| ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm#Equals.28Object.29// |
| == Return Value == | == Return Value == | ||
| Line 70: | Line 73: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm#GetHashCode.28.29// |
| == Return Value == | == Return Value == | ||
| Line 82: | Line 85: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm#GetType.28.29// |
| == Return Value == | == Return Value == | ||
| Line 95: | Line 98: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetRouteCore(RoutingSource,String,String) ** | ** {{wiki:ProtectedMethod.gif|}} GetRouteCore(RoutingSource,String,String) ** | ||
| - | This method returns a RoutingResult based on the extent you provided. | + | * //This method returns a RoutingResult based on the extent you provided.// |
| == Remarks == | == 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. | + | * //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 Value == | ||
| Line 119: | Line 122: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnFindingRoute(FindingRouteRoutingAlgorithmEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnFindingRoute(FindingRouteRoutingAlgorithmEventArgs) ** | ||
| - | N/A | + | * //This method allows you to raise the FindingRoute event from a derived class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm#OnFindingRoute.28FindingRouteRoutingAlgorithmEventArgs.29// |
| == Return Value == | == Return Value == | ||
| Line 135: | Line 138: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm#Finalize.28.29// |
| == Return Value == | == Return Value == | ||
| Line 147: | Line 150: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm#MemberwiseClone.28.29// |
| == Return Value == | == Return Value == | ||
| Line 162: | Line 165: | ||
| N/A | N/A | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm#GeographyUnit |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| Line 170: | Line 173: | ||
| N/A | N/A | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm#DistanceUnit |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| Line 177: | Line 180: | ||
| ==== Public Events ==== | ==== Public Events ==== | ||
| ** {{wiki:PublicEvent.gif|}} FindingRoute ** | ** {{wiki:PublicEvent.gif|}} FindingRoute ** | ||
| - | N/A | + | This event is called after finding the adjacent routeSegments. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | This event is called after finding the adjacent routeSegments. It wil be called many times during the route. |
| Event Arguments:[[ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs|FindingRouteRoutingAlgorithmEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs|FindingRouteRoutingAlgorithmEventArgs]] | ||
thinkgeo.mapsuite.routing.dijkstraroutingalgorithm.1442545579.txt.gz ยท Last modified: 2015/09/18 03:06 by admin