thinkgeo.mapsuite.routing.astarroutingalgorithm
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.astarroutingalgorithm [2015/09/11 02:35] admin [AStarRoutingAlgorithm()] |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm ====== | ||
| - | |||
| - | |||
| - | This class represents a routing algorithm that is based on the A* algorithm. | ||
| - | === Remarks === | ||
| - | The A* algorithm is one of the best graph search algorithms that finds the least-cost path from a given start point to a given end point. It uses a distance-plus-cost heuristic function to determine the order in which the search visits routeSegments in the data. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | * [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm]] | ||
| - | * [[ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#AStarRoutingAlgorithm()|AStarRoutingAlgorithm]] | | | This is a constructor for this class. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== 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 | [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]] | 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 | [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]](overriden) | 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]] | [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]] | This method allows you to raise the FindingRoute event from a derived class. | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#AStartRouteModifier|AStartRouteModifier]] | Single | | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]] | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#GeographyUnit|GeographyUnit]] | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]] | | | ||
| - | |||
| - | ==== 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]] | [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]] | This event is called after finding the adjacent routeSegments. | | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== AStarRoutingAlgorithm() ==== | ||
| - | This is a constructor for this class. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:// "http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#AStarRoutingAlgorithm.28.29"// | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== 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.AStarRoutingAlgorithm#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#Equals.28Object.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#GetHashCode.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#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]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Routing.RouteSegment} --> | Routing result that contains path information. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | routingSource | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]]<!-- ThinkGeo.MapSuite.Routing.RoutingSource --> | The routing source that contains the routeSegments to route on. | | ||
| - | | 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 --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#GetType.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#ToString.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== Finalize() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#Finalize.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#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]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Routing.RouteSegment} --> | Routing result that contains path information. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | routingSource | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]]<!-- ThinkGeo.MapSuite.Routing.RoutingSource --> | The routing source that contains the routeSegments to route on. | | ||
| - | | 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(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#MemberwiseClone.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#OnFindingRoute.28FindingRouteRoutingAlgorithmEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#OnFindingRoute.28FindingRouteRoutingAlgorithmEventArgs.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | [[ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs|FindingRouteRoutingAlgorithmEventArgs]]<!-- ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingAlgorithm --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== AStartRouteModifier ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#AStartRouteModifier" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#AStartRouteModifier</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== DistanceUnit ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#DistanceUnit" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#DistanceUnit</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingAlgorithm --> | ||
| - | [[#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.AStarRoutingAlgorithm#GeographyUnit" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm#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]] | ||
thinkgeo.mapsuite.routing.astarroutingalgorithm.1441938949.txt.gz ยท Last modified: 2015/09/11 02:35 by admin
