Differences

This shows you the differences between two versions of the page.

--- thinkgeo.mapsuite.routing.routingalgorithm [2015/08/20 03:08]
127.0.0.1 external edit
+++ thinkgeo.mapsuite.routing.routingalgorithm [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Routing.RoutingAlgorithm ======
+{{section>upgrade_map_suite_to_10.0}}
-<!-- Class -->
 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
+  *System.Object
-**[[ThinkGeo.MapSuite.Routing.RoutingAlgorithm]]
+    ***ThinkGeo.MapSuite.Routing.RoutingAlgorithm**
-***[[ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm]]
+      *[[ThinkGeo.MapSuite.Routing.BidirectionalRoutingAlgorithm]]
-***[[ThinkGeo.MapSuite.Routing.BidirectionalRoutingAlgorithm]]
+      *[[ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm]]
-***[[ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm]]
+      *[[ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm]]
 ===== Members Summary =====
 ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
 ==== Protected Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:ProtectedMethod.gif|}} RoutingAlgorithm() **
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#RoutingAlgorithm()|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 ==
+  * //This is the default constructor for the RoutingAlgorithm and should be called by inherited classes.//
+== Parameters ==
+<div newline></div>
 ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} GetRoute(RoutingSource,String,String) **
-| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetRoute(RoutingSource, String, String)|GetRoute]]   | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]], String, String   |    | This method returns a RoutingResult based on the extent you provided.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |
-==== Protected Methods ====
+  * //This method returns a RoutingResult based on the extent you provided.//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
+  * //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.//
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetRouteCore(RoutingSource, String, String)|GetRouteCore]]   | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]], String, String   |    | This method returns a RoutingResult based on the extent you provided.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnFindingRoute(FindingRouteRoutingAlgorithmEventArgs)|OnFindingRoute]]   | [[ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs|FindingRouteRoutingAlgorithmEventArgs]]   |    | This method allows you to raise the FindingRoute event from a derived class.   |
-==== Public Properties ====
+== Return Value ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+  * Type:Collection<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]>
-| {{wiki:PublicProperty.gif|Public Property}}[[#DistanceUnit|DistanceUnit]]   | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]   |    |    |
+  * Description:Routing result that contains path information.
-| {{wiki:PublicProperty.gif|Public Property}}[[#GeographyUnit|GeographyUnit]]   | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]   |    |    |
-==== Protected Properties ====
+== Parameters ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+  * //routingSource//
+    * Type:[[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]]
+    * Description:The routing source that contains the routeSegments to route on.
-==== Public Events ====
+  * //startFeatureId//
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
+    * Type:String
-| {{wiki:PublicEvent.gif|Public Event}}[[#FindingRoute|FindingRoute]]   | [[ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs|FindingRouteRoutingAlgorithmEventArgs]]   |    | This event is called after finding the adjacent routeSegments.   |
+    * Description:The feature ID which represents the starting routeSegment.
-===== Public Constructors =====
+  * //endFeatureId//
-===== Protected Constructors =====
+    * Type:String
-==== RoutingAlgorithm() ====
+    * Description:The feature ID which represents the ending routeSegment.
-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 ^
-[[#Protected Constructors|Go Back]]
+<div newline></div>
-===== Public Methods =====
+** {{wiki:PublicMethod.gif|}} ToString() **
-==== Equals(Object) ====
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#Equals.28Object.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Boolean<!-- System.Boolean -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| obj   | Object<!-- System.Object -->   |    |
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#ToString.28.29//
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:String
-==== GetHashCode() ====
+  * Description:N/A
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#GetHashCode.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Int32<!-- System.Int32 -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-<!-- System.Object -->
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== GetRoute(RoutingSource, String, String) ====
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#Equals.28Object.29//
-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<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Routing.RouteSegment} -->   | Routing result that contains path information.   |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Boolean
-| routingSource   | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]]<!-- ThinkGeo.MapSuite.Routing.RoutingSource -->   | The routing source that contains the routeSegments to route on.   |
+  * Description:N/A
-| 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 -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+  * //obj//
-==== GetType() ====
+    * Type:Object
-=== Remarks ===
+    * Description:N/A
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#GetType.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Type<!-- System.Type -->   |    |
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-<!-- System.Object -->
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== ToString() ====
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#GetHashCode.28.29//
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#ToString.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Int32
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-===== Protected Methods =====
+** {{wiki:PublicMethod.gif|}} GetType() **
-==== Finalize() ====
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#Finalize.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== 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//
-<!-- System.Object -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:Type
-==== GetRouteCore(RoutingSource, String, String) ====
+  * Description:N/A
-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<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Routing.RouteSegment} -->   | Routing result that contains path information.   |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
-| routingSource   | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]]<!-- ThinkGeo.MapSuite.Routing.RoutingSource -->   | The routing source that contains the routeSegments to route on.   |
+==== Protected Methods ====
-| startFeatureId   | String<!-- System.String -->   | The feature ID which represents the starting routeSegment.   |
+** {{wiki:ProtectedMethod.gif|}} GetRouteCore(RoutingSource,String,String) **
-| endFeatureId   | String<!-- System.String -->   | The feature ID which represents the ending routeSegment.   |
-<!-- ThinkGeo.MapSuite.Routing.RoutingAlgorithm -->
+  * //This method returns a RoutingResult based on the extent you provided.//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-==== MemberwiseClone() ====
+  * //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.//
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#MemberwiseClone.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Object<!-- System.Object -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Collection<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]>
+  * Description:Routing result that contains path information.
-<!-- System.Object -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+  * //routingSource//
-==== OnFindingRoute(FindingRouteRoutingAlgorithmEventArgs) ====
+    * Type:[[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]]
-This method allows you to raise the FindingRoute event from a derived class.
+    * Description:The routing source that contains the routeSegments to route on.
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#OnFindingRoute.28FindingRouteRoutingAlgorithmEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#OnFindingRoute.28FindingRouteRoutingAlgorithmEventArgs.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //startFeatureId//
-^  Name ^  Type ^  Description ^
+    * Type:String
-| e   | [[ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs|FindingRouteRoutingAlgorithmEventArgs]]<!-- ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs -->   |    |
+    * Description:The feature ID which represents the starting routeSegment.
-<!-- ThinkGeo.MapSuite.Routing.RoutingAlgorithm -->
+  * //endFeatureId//
-[[#Protected Methods|Go Back]]
+    * Type:String
-===== Public Properties =====
+    * Description:The feature ID which represents the ending routeSegment.
-==== DistanceUnit ====
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#DistanceUnit" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#DistanceUnit</a>
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit -->   |
-<!-- ThinkGeo.MapSuite.Routing.RoutingAlgorithm -->
+<div newline></div>
-[[#Public Properties|Go Back]]
+** {{wiki:ProtectedMethod.gif|}} OnFindingRoute(FindingRouteRoutingAlgorithmEventArgs) **
-==== 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 ^
-| [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit -->   |
-<!-- ThinkGeo.MapSuite.Routing.RoutingAlgorithm -->
+  * //This method allows you to raise the FindingRoute event from a derived class.//
-[[#Public Properties|Go Back]]
+== Remarks ==
-===== Protected Properties =====
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#OnFindingRoute.28FindingRouteRoutingAlgorithmEventArgs.29//
-===== Public Events =====
-==== FindingRoute ====
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+  * //e//
+    * Type:[[ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs|FindingRouteRoutingAlgorithmEventArgs]]
+    * Description:N/A
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
+  * //N/A//
+== 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 ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
+  * //N/A//
+== 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 ==
+  * Type:Object
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+==== Public Properties ====
+** {{wiki:PublicProperty.gif|}} GeographyUnit **
+N/A
+== Remarks ==
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingAlgorithm#GeographyUnit
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]
+** {{wiki:PublicProperty.gif|}} DistanceUnit **
+N/A
+== 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 ==
+  * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]
+==== Protected Properties ====
+==== Public Events ====
+** {{wiki:PublicEvent.gif|}} FindingRoute **
 This event is called after finding the adjacent routeSegments.
-=== Remarks ===
+== Remarks ==
 This event is called after finding the adjacent routeSegments. It wil be called many times during the route.
-=== Event Arguments ===
-^ Event Arguments ^
-| [[ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs|FindingRouteRoutingAlgorithmEventArgs]]<!-- ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs -->   |
-<!-- ThinkGeo.MapSuite.Routing.RoutingAlgorithm -->
+Event Arguments:[[ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs|FindingRouteRoutingAlgorithmEventArgs]]
-[[#Public Events|Go Back]]
-__NOTOC__
-[[Category:MapSuiteRouting]]
-[[Category:ThinkGeo.MapSuite.Routing]]
-[[Category:UpdateDocumentation]]

User Tools

Site Tools

Differences

Page Tools