ThinkGeo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== 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
    * [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm]]
      *  [[ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm]]
          * [[ThinkGeo.MapSuite.Routing.BidirectionalRoutingAlgorithm]]
            * [[ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm]]
===== Members Summary =====
==== Public Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^

==== Protected Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#RoutingAlgorithm()|RoutingAlgorithm]]   |    |    | This is the default constructor for the RoutingAlgorithm and should be called by inherited classes.   |

==== Public Methods ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{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 ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
| {{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 ====
^ Name ^ Return ^ DeclaringType ^ Summary ^
| {{wiki:PublicProperty.gif|Public Property}}[[#DistanceUnit|DistanceUnit]]   | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]   |    |    |
| {{wiki:PublicProperty.gif|Public Property}}[[#GeographyUnit|GeographyUnit]]   | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]   |    |    |

==== Protected Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^

==== Public Events ====
^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
| {{wiki:PublicEvent.gif|Public Event}}[[#FindingRoute|FindingRoute]]   | [[ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs|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 ^

[[#Protected Constructors|Go Back]]
===== 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 |    |

[[#Public Methods|Go Back]]
==== 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 ^

[[#Public Methods|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<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]>  | Routing result that contains path information.   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| routingSource   | [[ThinkGeo.MapSuite.Routing.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.   |


[[#Public Methods|Go Back]]
==== 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 ^

[[#Public Methods|Go Back]]
==== 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 ^


[[#Public Methods|Go Back]]
===== 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 ^

[[#Protected Methods|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<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]>  | Routing result that contains path information.   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| routingSource   | [[ThinkGeo.MapSuite.Routing.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.   |


[[#Protected Methods|Go Back]]
==== 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 ^


[[#Protected Methods|Go Back]]
==== 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   | [[ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs|FindingRouteRoutingAlgorithmEventArgs]] |    |

[[#Protected Methods|Go Back]]
===== 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 ^
| [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]  |


[[#Public Properties|Go Back]]
==== 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 -->
[[#Public Properties|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 ^
| [[ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs|FindingRouteRoutingAlgorithmEventArgs]]<!-- ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs -->   |

<!-- ThinkGeo.MapSuite.Routing.RoutingAlgorithm -->
[[#Public Events|Go Back]]

__NOTOC__
[[Category:MapSuiteRouting]]
[[Category:ThinkGeo.MapSuite.Routing]]
[[Category:UpdateDocumentation]]
User Tools

Site Tools

Page Tools
