This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.routing.routingalgorithm [2015/09/18 03:06] admin |
thinkgeo.mapsuite.routing.routingalgorithm [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Routing.RoutingAlgorithm ====== | ====== ThinkGeo.MapSuite.Routing.RoutingAlgorithm ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
This class is the base class for all types of RoutingAlgorithm. | This class is the base class for all types of RoutingAlgorithm. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 12: | Line 15: | ||
** {{wiki:ProtectedMethod.gif|}} RoutingAlgorithm() ** | ** {{wiki:ProtectedMethod.gif|}} RoutingAlgorithm() ** | ||
- | This is the default constructor for the RoutingAlgorithm and should be called by inherited classes. | + | * //This is the default constructor for the RoutingAlgorithm and should be called by inherited classes.// |
== Remarks == | == Remarks == | ||
- | This is the default constructor for the RoutingAlgorithm and should be called by inherited classes. | + | * //This is the default constructor for the RoutingAlgorithm and should be called by inherited classes.// |
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
Line 20: | Line 23: | ||
** {{wiki:PublicMethod.gif|}} GetRoute(RoutingSource,String,String) ** | ** {{wiki:PublicMethod.gif|}} GetRoute(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 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. | + | * //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 == | ||
Line 44: | Line 47: | ||
** {{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.RoutingAlgorithm#ToString.28.29// |
== Return Value == | == Return Value == | ||
Line 56: | Line 59: | ||
** {{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.RoutingAlgorithm#Equals.28Object.29// |
== Return Value == | == Return Value == | ||
Line 72: | Line 75: | ||
** {{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.RoutingAlgorithm#GetHashCode.28.29// |
== Return Value == | == Return Value == | ||
Line 84: | Line 87: | ||
** {{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.RoutingAlgorithm#GetType.28.29// |
== Return Value == | == Return Value == | ||
Line 97: | Line 100: | ||
** {{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 121: | Line 124: | ||
** {{wiki:ProtectedMethod.gif|}} OnFindingRoute(FindingRouteRoutingAlgorithmEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnFindingRoute(FindingRouteRoutingAlgorithmEventArgs) ** | ||
- | This method allows you to raise the FindingRoute event from a derived class. | + | * //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.RoutingAlgorithm#OnFindingRoute.28FindingRouteRoutingAlgorithmEventArgs.29// |
== Return Value == | == Return Value == | ||
Line 137: | Line 140: | ||
** {{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.RoutingAlgorithm#Finalize.28.29// |
== Return Value == | == Return Value == | ||
Line 149: | Line 152: | ||
** {{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.RoutingAlgorithm#MemberwiseClone.28.29// |
== Return Value == | == Return Value == | ||
Line 164: | Line 167: | ||
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.RoutingAlgorithm#GeographyUnit |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
Line 172: | Line 175: | ||
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.RoutingAlgorithm#DistanceUnit |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] |