thinkgeo.mapsuite.routing.routingalgorithm
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
thinkgeo.mapsuite.routing.routingalgorithm [2015/09/22 08:32] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Routing.RoutingAlgorithm ====== | ||
| - | This class is the base class for all types of RoutingAlgorithm. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | ***ThinkGeo.MapSuite.Routing.RoutingAlgorithm** | ||
| - | *[[ThinkGeo.MapSuite.Routing.BidirectionalRoutingAlgorithm]] | ||
| - | *[[ThinkGeo.MapSuite.Routing.AStarRoutingAlgorithm]] | ||
| - | *[[ThinkGeo.MapSuite.Routing.DijkstraRoutingAlgorithm]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ==== Protected Constructors ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 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 == | ||
| - | <div newline></div> | ||
| - | ==== Public Methods ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:Collection<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]> | ||
| - | * Description:Routing result that contains path information. | ||
| - | |||
| - | == Parameters == | ||
| - | * //routingSource// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]] | ||
| - | * Description:The routing source that contains the routeSegments to route on. | ||
| - | |||
| - | * //startFeatureId// | ||
| - | * Type:String | ||
| - | * Description:The feature ID which represents the starting routeSegment. | ||
| - | |||
| - | * //endFeatureId// | ||
| - | * Type:String | ||
| - | * Description:The feature ID which represents the ending routeSegment. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == 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 == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == 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 == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //obj// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == 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 == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == 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 == | ||
| - | * Type:Type | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Protected Methods ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 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 == | ||
| - | * Type:Collection<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]> | ||
| - | * Description:Routing result that contains path information. | ||
| - | |||
| - | == Parameters == | ||
| - | * //routingSource// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]] | ||
| - | * Description:The routing source that contains the routeSegments to route on. | ||
| - | |||
| - | * //startFeatureId// | ||
| - | * Type:String | ||
| - | * Description:The feature ID which represents the starting routeSegment. | ||
| - | |||
| - | * //endFeatureId// | ||
| - | * Type:String | ||
| - | * Description:The feature ID which represents the ending routeSegment. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 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 == | ||
| - | * 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 == | ||
| - | 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]] | ||
| - | |||
thinkgeo.mapsuite.routing.routingalgorithm.1442910763.txt.gz ยท Last modified: 2015/09/22 08:32 by admin
