thinkgeo.mapsuite.routing.routingengine
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.routing.routingengine [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.routing.routingengine [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Routing.RoutingEngine ====== | ====== ThinkGeo.MapSuite.Routing.RoutingEngine ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| This class is for finding a route. | This class is for finding a route. | ||
| - | === Remarks === | ||
| - | The RoutingEngine class is a high level object that supports finding route functions. We only support two-point routes; multi-point routes are not supported at this time. You can also define service ranges based on limits of speed and time. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.Routing.RoutingEngine]] | + | ***ThinkGeo.MapSuite.Routing.RoutingEngine** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} RoutingEngine() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RoutingEngine()|RoutingEngine]] | | | This is a constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RoutingEngine(RoutingSource)|RoutingEngine]] | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]] | | This is a constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RoutingEngine(RoutingSource, FeatureSource)|RoutingEngine]] | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]], [[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | | This is a constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RoutingEngine(RoutingSource, RoutingAlgorithm)|RoutingEngine]] | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]], [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]] | | This is a constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RoutingEngine(RoutingSource, RoutingAlgorithm, FeatureSource)|RoutingEngine]] | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]], [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]], [[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | | This is a constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RoutingEngine(RoutingSource, RoutingAlgorithm, FeatureSource, GeographyUnit)|RoutingEngine]] | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]], [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]], [[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | | This is a constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RoutingEngine(RoutingSource, RoutingAlgorithm, FeatureSource, GeographyUnit, DistanceUnit)|RoutingEngine]] | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]], [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]], [[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | | This is a constructor for the class. | | + | |
| - | ==== Protected Constructors ==== | + | * //This is a constructor for the class.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //The default settings are: RoutingSource is null, routingAlgorithm is Dijkstra, FeatureSource is null, GeographyUnit is DecimalDegree, DistanceUnit is Kilometer.// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RoutingEngine(RoutingSource) ** | ||
| + | * //This is a constructor for the class.// | ||
| + | == Remarks == | ||
| + | * //The default settings are: RoutingSource is null, routingAlgorithm is Dijkstra, FeatureSource is null, GeographyUnit is DecimalDegree, DistanceUnit is Kilometer.// | ||
| + | == Parameters == | ||
| + | * //routingSource// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RoutingEngine(RoutingSource,FeatureSource) ** | ||
| + | |||
| + | * //This is a constructor for the class.// | ||
| + | == Remarks == | ||
| + | * //The default settings are: RoutingSource is null, routingAlgorithm is Dijkstra, FeatureSource is null, GeographyUnit is DecimalDegree, DistanceUnit is Kilometer.// | ||
| + | == Parameters == | ||
| + | * //routingSource// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //featureSource// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RoutingEngine(RoutingSource,RoutingAlgorithm) ** | ||
| + | |||
| + | * //This is a constructor for the class.// | ||
| + | == Remarks == | ||
| + | * //The default settings are: RoutingSource is null, routingAlgorithm is Dijkstra, FeatureSource is null, GeographyUnit is DecimalDegree, DistanceUnit is Kilometer.// | ||
| + | == Parameters == | ||
| + | * //routingSource// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //routingAlgorithm// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RoutingEngine(RoutingSource,RoutingAlgorithm,FeatureSource) ** | ||
| + | |||
| + | * //This is a constructor for the class.// | ||
| + | == Remarks == | ||
| + | * //The default settings are: RoutingSource is null, routingAlgorithm is Dijkstra, FeatureSource is null, GeographyUnit is DecimalDegree, DistanceUnit is Kilometer.// | ||
| + | == Parameters == | ||
| + | * //routingSource// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //routingAlgorithm// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //featureSource// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RoutingEngine(RoutingSource,RoutingAlgorithm,FeatureSource,GeographyUnit) ** | ||
| + | |||
| + | * //This is a constructor for the class.// | ||
| + | == Remarks == | ||
| + | * //The default settings are: RoutingSource is null, routingAlgorithm is Dijkstra, FeatureSource is null, GeographyUnit is DecimalDegree, DistanceUnit is Kilometer.// | ||
| + | == Parameters == | ||
| + | * //routingSource// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //routingAlgorithm// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //featureSource// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //geographyUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RoutingEngine(RoutingSource,RoutingAlgorithm,FeatureSource,GeographyUnit,DistanceUnit) ** | ||
| + | |||
| + | * //This is a constructor for the class.// | ||
| + | == Remarks == | ||
| + | * //The default settings are: RoutingSource is null, routingAlgorithm is Dijkstra, FeatureSource is null, GeographyUnit is DecimalDegree, DistanceUnit is Kilometer.// | ||
| + | == Parameters == | ||
| + | * //routingSource// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //routingAlgorithm// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //featureSource// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //geographyUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //distanceUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ==== Protected Constructors ==== | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GetRouteSegments(String,String) ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GenerateServiceArea(String, TimeSpan, Single, SpeedUnit, Double, GeographyUnit)|GenerateServiceArea]] | String, TimeSpan, Single, [[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]], Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GenerateServiceArea(String, TimeSpan, Single, SpeedUnit)|GenerateServiceArea]] | String, TimeSpan, Single, [[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]] | | This method returns a polygon that represents the service area around any location on a map. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GenerateServiceArea(PointShape, TimeSpan, Single, SpeedUnit, Double, GeographyUnit)|GenerateServiceArea]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], TimeSpan, Single, [[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]], Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GenerateServiceArea(PointShape, TimeSpan, Single, SpeedUnit)|GenerateServiceArea]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], TimeSpan, Single, [[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]] | | This method returns a polygon that represents the service area around any location on a map. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GenerateServiceArea(String, TimeSpan, Double, GeographyUnit)|GenerateServiceArea]] | String, TimeSpan, Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GenerateServiceArea(String, TimeSpan)|GenerateServiceArea]] | String, TimeSpan | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GenerateServiceArea(PointShape, TimeSpan)|GenerateServiceArea]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], TimeSpan | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GenerateServiceArea(PointShape, TimeSpan, Double, GeographyUnit)|GenerateServiceArea]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], TimeSpan, Double, [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GenerateServiceArea(Double, Double, TimeSpan, Single, SpeedUnit)|GenerateServiceArea]] | Double, Double, TimeSpan, Single, [[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]] | | This method returns a polygon that represents the service area around any location on a map. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#GetAngleBetweenTwoLines(LineShape, LineShape)|GetAngleBetweenTwoLines]] | [[ThinkGeo.MapSuite.Core.LineShape|LineShape]], [[ThinkGeo.MapSuite.Core.LineShape|LineShape]] | | This method returns the angle between two lines. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#GetDrivingDirection(LineShape, LineShape)|GetDrivingDirection]] | [[ThinkGeo.MapSuite.Core.LineShape|LineShape]], [[ThinkGeo.MapSuite.Core.LineShape|LineShape]] | | This method returns the DrivingDirection based on the from line shape. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRoute(String, String, IEnumerable<String>, Int32)|GetRoute]] | String, String, IEnumerable<String>, Int32 | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRoute(String, String)|GetRoute]] | String, String | | This method returns the routing path based on two feature IDs that represent two routeSegments. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRoute(String, IEnumerable<String>, Int32)|GetRoute]] | String, IEnumerable<String>, Int32 | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRoute(String, IEnumerable<String>)|GetRoute]] | String, IEnumerable<String> | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRoute(PointShape, PointShape, IEnumerable<PointShape>, Int32)|GetRoute]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]>, Int32 | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRoute(PointShape, PointShape, IEnumerable<PointShape>)|GetRoute]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]> | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRoute(PointShape, IEnumerable<PointShape>, Int32)|GetRoute]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]>, Int32 | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRoute(PointShape, IEnumerable<PointShape>)|GetRoute]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]> | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRoute(PointShape, PointShape)|GetRoute]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], [[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | | This method returns the routing path based on two points. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRoute(String, String, IEnumerable<String>)|GetRoute]] | String, String, IEnumerable<String> | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRouteSegments(String, String)|GetRouteSegments]] | String, String | | This method returns a sequential routeSegments collection consisting of the route based on RoutingSource and does not use a FeatureSource. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| - | ==== Protected Methods ==== | + | * //This method returns a sequential routeSegments collection consisting of the route based on RoutingSource and does not use a FeatureSource.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //This method for users who don't know the feature source. If the user knows the feature source, they should use GetRoute to get more information. This method is one of the most common routing requirements for a simple path, wherein a customer inputs two feature IDs that represent routeSegments and then finds a route. The route will be calculated from a specified start routeSegment to a specified end routeSegment.// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetRouteCore(String, String, IEnumerable<String>, Int32)|GetRouteCore]] | String, String, IEnumerable<String>, Int32 | | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetRouteCoreWithPoints(PointShape, PointShape, IEnumerable<PointShape>, Int32)|GetRouteCoreWithPoints]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]>, Int32 | | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnGeneratingServiceArea(GeneratingServiceAreaRoutingEngineEventArgs)|OnGeneratingServiceArea]] | [[ThinkGeo.MapSuite.Routing.GeneratingServiceAreaRoutingEngineEventArgs|GeneratingServiceAreaRoutingEngineEventArgs]] | | This method allows you to raise the GeneratingServiceArea event from a derived class. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnGettingRouteViaVisitStops(GettingRouteViaVisitStopsRoutingEngineEventArgs)|OnGettingRouteViaVisitStops]] | [[ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs|GettingRouteViaVisitStopsRoutingEngineEventArgs]] | | This method allows you to raise the GetRouteViaVisitStops 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]] | | Gets or sets a value that represents the distance unit of the route. | | + | * Description:N/A |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#FeatureSource|FeatureSource]] | [[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | | Gets or sets a value that represents the FeatureSource used for finding the route. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#GeographyUnit|GeographyUnit]] | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | | Gets or sets a value that represents the geography unit of the FeatureSource. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RoutingAlgorithm|RoutingAlgorithm]] | [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]] | | Gets or sets a value that represents the routingAlgorithm used for finding the route. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RoutingResultsType|RoutingResultsType]] | [[ThinkGeo.MapSuite.Routing.RoutingResultsType|RoutingResultsType]] | | Gets or sets a value that represents how much data is returned in the routing results. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RoutingSource|RoutingSource]] | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]] | | Gets or sets a routingSource object for finding the route. | | + | |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * //startFeatureId// |
| + | * Type:String | ||
| + | * Description:This parameter is the start point of the route. | ||
| - | ==== Public Events ==== | + | * //endFeatureId// |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | * Type:String |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#GeneratingServiceArea|GeneratingServiceArea]] | [[ThinkGeo.MapSuite.Routing.GeneratingServiceAreaRoutingEngineEventArgs|GeneratingServiceAreaRoutingEngineEventArgs]] | | This event is called during the generating service area. | | + | * Description:This parameter is the end point of the route. |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#GettingRouteViaVisitStops|GettingRouteViaVisitStops]] | [[ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs|GettingRouteViaVisitStopsRoutingEngineEventArgs]] | | This event is called during the calculating best visit sequence | | + | |
| - | ===== Public Constructors ===== | + | <div newline></div> |
| - | ==== RoutingEngine() ==== | + | ** {{wiki:PublicMethod.gif|}} GetRoute(PointShape,PointShape) ** |
| - | This is a constructor for the class. | + | |
| - | === Remarks === | + | |
| - | The default settings are: RoutingSource is null, routingAlgorithm is Dijkstra, FeatureSource is null, GeographyUnit is DecimalDegree, DistanceUnit is Kilometer. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | * //This method returns the routing path based on two points.// |
| - | ==== RoutingEngine(RoutingSource) ==== | + | == Remarks == |
| - | This is a constructor for the class. | + | * //This method generates turn-by-turn driving directions for any route. It cannot be changed by overriding GetRouteCore. This method is for users who know the feature source. If the user does not know the feature source, they should use GetRouteSegments instead. This method is one of the most common routing requirements for a simple path, wherein a customer inputs two points and then finds a route. The route will be calculated from a specified start point to a specified end point.// |
| - | === Remarks === | + | |
| - | The default settings are: RoutingSource is null, routingAlgorithm is Dijkstra, FeatureSource is null, GeographyUnit is DecimalDegree, DistanceUnit is Kilometer. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | routingSource | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]]<!-- ThinkGeo.MapSuite.Routing.RoutingSource --> | | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Return Value == |
| - | ==== RoutingEngine(RoutingSource, FeatureSource) ==== | + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]] |
| - | This is a constructor for the class. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | The default settings are: RoutingSource is null, routingAlgorithm is Dijkstra, FeatureSource is null, GeographyUnit is DecimalDegree, DistanceUnit is Kilometer. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | routingSource | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]]<!-- ThinkGeo.MapSuite.Routing.RoutingSource --> | | | + | |
| - | | featureSource | [[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]]<!-- ThinkGeo.MapSuite.Core.FeatureSource --> | | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== RoutingEngine(RoutingSource, RoutingAlgorithm) ==== | + | * //startPoint// |
| - | This is a constructor for the class. | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | === Remarks === | + | * Description:This parameter is the start point which represents a routeSegment for the start of the route. |
| - | The default settings are: RoutingSource is null, routingAlgorithm is Dijkstra, FeatureSource is null, GeographyUnit is DecimalDegree, DistanceUnit is Kilometer. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | routingSource | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]]<!-- ThinkGeo.MapSuite.Routing.RoutingSource --> | | | + | |
| - | | routingAlgorithm | [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]]<!-- ThinkGeo.MapSuite.Routing.RoutingAlgorithm --> | | | + | |
| - | [[#Public Constructors|Go Back]] | + | * //endPoint// |
| - | ==== RoutingEngine(RoutingSource, RoutingAlgorithm, FeatureSource) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | This is a constructor for the class. | + | * Description:This parameter is the end point which represents a routeSegment for the end of the route. |
| - | === Remarks === | + | |
| - | The default settings are: RoutingSource is null, routingAlgorithm is Dijkstra, FeatureSource is null, GeographyUnit is DecimalDegree, DistanceUnit is Kilometer. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | routingSource | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]]<!-- ThinkGeo.MapSuite.Routing.RoutingSource --> | | | + | |
| - | | routingAlgorithm | [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]]<!-- ThinkGeo.MapSuite.Routing.RoutingAlgorithm --> | | | + | |
| - | | featureSource | [[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]]<!-- ThinkGeo.MapSuite.Core.FeatureSource --> | | | + | |
| - | [[#Public Constructors|Go Back]] | + | <div newline></div> |
| - | ==== RoutingEngine(RoutingSource, RoutingAlgorithm, FeatureSource, GeographyUnit) ==== | + | ** {{wiki:PublicMethod.gif|}} GetRoute(PointShape,IEnumerable<PointShape>) ** |
| - | This is a constructor for the class. | + | |
| - | === Remarks === | + | |
| - | The default settings are: RoutingSource is null, routingAlgorithm is Dijkstra, FeatureSource is null, GeographyUnit is DecimalDegree, DistanceUnit is Kilometer. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | routingSource | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]]<!-- ThinkGeo.MapSuite.Routing.RoutingSource --> | | | + | |
| - | | routingAlgorithm | [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]]<!-- ThinkGeo.MapSuite.Routing.RoutingAlgorithm --> | | | + | |
| - | | featureSource | [[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]]<!-- ThinkGeo.MapSuite.Core.FeatureSource --> | | | + | |
| - | | geographyUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | | | + | |
| - | [[#Public Constructors|Go Back]] | + | * //N/A// |
| - | ==== RoutingEngine(RoutingSource, RoutingAlgorithm, FeatureSource, GeographyUnit, DistanceUnit) ==== | + | == Remarks == |
| - | This is a constructor for the class. | + | * //For the most updated Info for this topic, please check it here:// |
| - | === Remarks === | + | |
| - | The default settings are: RoutingSource is null, routingAlgorithm is Dijkstra, FeatureSource is null, GeographyUnit is DecimalDegree, DistanceUnit is Kilometer. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | routingSource | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]]<!-- ThinkGeo.MapSuite.Routing.RoutingSource --> | | | + | |
| - | | routingAlgorithm | [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]]<!-- ThinkGeo.MapSuite.Routing.RoutingAlgorithm --> | | | + | |
| - | | featureSource | [[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]]<!-- ThinkGeo.MapSuite.Core.FeatureSource --> | | | + | |
| - | | geographyUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | | | + | |
| - | | distanceUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Return Value == |
| - | ===== Protected Constructors ===== | + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]] |
| - | ===== Public Methods ===== | + | * Description:N/A |
| - | ==== 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.RoutingEngine#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#Equals.28Object.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //startPoint// |
| - | | obj | Object<!-- System.Object --> | | | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | * //stops// |
| - | [[#Public Methods|Go Back]] | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]> |
| - | ==== GenerateServiceArea(String, TimeSpan, Single, SpeedUnit, Double, GeographyUnit) ==== | + | * 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.RoutingEngine#GenerateServiceArea.28String.2C_TimeSpan.2C_Single.2C_SpeedUnit.2C_Double.2C_GeographyUnit.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28String.2C_TimeSpan.2C_Single.2C_SpeedUnit.2C_Double.2C_GeographyUnit.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.Core.PolygonShape --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetRoute(PointShape,IEnumerable<PointShape>,Int32) ** |
| - | | centerFeatureId | String<!-- System.String --> | | | + | |
| - | | drivingTime | TimeSpan<!-- System.TimeSpan --> | | | + | |
| - | | averageSpeed | Single<!-- System.Single --> | | | + | |
| - | | speedUnit | [[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]]<!-- ThinkGeo.MapSuite.Routing.SpeedUnit --> | | | + | |
| - | | gridSize | Double<!-- System.Double --> | | | + | |
| - | | gridSizeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GenerateServiceArea(String, TimeSpan, Single, SpeedUnit) ==== | + | * //For the most updated Info for this topic, please check it here:// |
| - | This method returns a polygon that represents the service area around any location on a map. | + | |
| - | === Remarks === | + | |
| - | You can define service ranges based on limits of speed and time. A service area is a region that encompasses all accessible routes (such as streets). The default geography unit for a feature source is decimal degrees. The default distance unit for the average speed is kilometers. For example, the 5-minute service area for a point includes all the streets that can be reached within five minutes from that point. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.Core.PolygonShape --> | A polygon that represents the service area. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]] |
| - | | centerFeatureId | String<!-- System.String --> | This parameter is the feature ID that represents the center of the service area. | | + | * Description:N/A |
| - | | drivingTime | TimeSpan<!-- System.TimeSpan --> | This parameter represents the time interval used to find the boundaries of the service area. | | + | |
| - | | averageSpeed | Single<!-- System.Single --> | This parameter represents the average speed traveled inside the service area. | | + | |
| - | | speedUnit | [[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]]<!-- ThinkGeo.MapSuite.Routing.SpeedUnit --> | This parameter represents the unit of average speed traveled inside the service area. | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //startPoint// |
| - | ==== GenerateServiceArea(PointShape, TimeSpan, Single, SpeedUnit, Double, GeographyUnit) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | === 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.RoutingEngine#GenerateServiceArea.28PointShape.2C_TimeSpan.2C_Single.2C_SpeedUnit.2C_Double.2C_GeographyUnit.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28PointShape.2C_TimeSpan.2C_Single.2C_SpeedUnit.2C_Double.2C_GeographyUnit.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.Core.PolygonShape --> | | | + | |
| - | === Parameters === | + | * //stops// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]> |
| - | | centerPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | + | * Description:N/A |
| - | | drivingTime | TimeSpan<!-- System.TimeSpan --> | | | + | |
| - | | averageSpeed | Single<!-- System.Single --> | | | + | |
| - | | speedUnit | [[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]]<!-- ThinkGeo.MapSuite.Routing.SpeedUnit --> | | | + | |
| - | | gridSize | Double<!-- System.Double --> | | | + | |
| - | | gridSizeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | * //iterations// |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GenerateServiceArea(PointShape, TimeSpan, Single, SpeedUnit) ==== | + | * Description:N/A |
| - | This method returns a polygon that represents the service area around any location on a map. | + | |
| - | === Remarks === | + | |
| - | You can define service ranges based on limits of speed and time. A service area is a region that encompasses all accessible routes (such as streets). The default geography unit for a feature source is decimal degrees. The default distance unit for the average speed is kilometers. For example, the 5-minute service area for a point includes all the streets that can be reached within five minutes from that point. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.Core.PolygonShape --> | A polygon that represents the service area. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetRoute(PointShape,PointShape,IEnumerable<PointShape>) ** |
| - | | centerPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | This parameter is the point that represents the center of the service area. | | + | |
| - | | drivingTime | TimeSpan<!-- System.TimeSpan --> | This parameter represents the time interval used to find the boundaries of the service area. | | + | |
| - | | averageSpeed | Single<!-- System.Single --> | This parameter represents the average speed traveled inside the service area. | | + | |
| - | | speedUnit | [[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]]<!-- ThinkGeo.MapSuite.Routing.SpeedUnit --> | This parameter represents the unit of average speed traveled inside the service area. | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GenerateServiceArea(String, TimeSpan, Double, GeographyUnit) ==== | + | * //For the most updated Info for this topic, please check it here:// |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28String.2C_TimeSpan.2C_Double.2C_GeographyUnit.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28String.2C_TimeSpan.2C_Double.2C_GeographyUnit.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.Core.PolygonShape --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]] |
| - | | centerFeatureId | String<!-- System.String --> | | | + | * Description:N/A |
| - | | drivingTime | TimeSpan<!-- System.TimeSpan --> | | | + | |
| - | | gridSize | Double<!-- System.Double --> | | | + | |
| - | | gridSizeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //startPoint// |
| - | ==== GenerateServiceArea(String, TimeSpan) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | === 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.RoutingEngine#GenerateServiceArea.28String.2C_TimeSpan.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28String.2C_TimeSpan.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.Core.PolygonShape --> | | | + | |
| - | === Parameters === | + | * //endPoint// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | | centerFeatureId | String<!-- System.String --> | | | + | * Description:N/A |
| - | | drivingTime | TimeSpan<!-- System.TimeSpan --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | * //stops// |
| - | [[#Public Methods|Go Back]] | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]> |
| - | ==== GenerateServiceArea(PointShape, TimeSpan) ==== | + | * 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.RoutingEngine#GenerateServiceArea.28PointShape.2C_TimeSpan.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28PointShape.2C_TimeSpan.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.Core.PolygonShape --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetRoute(PointShape,PointShape,IEnumerable<PointShape>,Int32) ** |
| - | | centerPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | + | |
| - | | drivingTime | TimeSpan<!-- System.TimeSpan --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GenerateServiceArea(PointShape, TimeSpan, Double, GeographyUnit) ==== | + | * //For the most updated Info for this topic, please check it here:// |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28PointShape.2C_TimeSpan.2C_Double.2C_GeographyUnit.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28PointShape.2C_TimeSpan.2C_Double.2C_GeographyUnit.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.Core.PolygonShape --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]] |
| - | | centerPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | + | * Description:N/A |
| - | | drivingTime | TimeSpan<!-- System.TimeSpan --> | | | + | |
| - | | gridSize | Double<!-- System.Double --> | | | + | |
| - | | gridSizeUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //startPoint// |
| - | ==== GenerateServiceArea(Double, Double, TimeSpan, Single, SpeedUnit) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | This method returns a polygon that represents the service area around any location on a map. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | You can define service ranges based on limits of speed and time. A service area is a region that encompasses all accessible routes (such as streets). The default geography unit for a feature source is decimal degrees. The default distance unit for the average speed is kilometers. For example, the 5-minute service area for a point includes all the streets that can be reached within five minutes from that point. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.Core.PolygonShape --> | A polygon that represents the service area. | | + | |
| - | === Parameters === | + | * //endPoint// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | | centerX | Double<!-- System.Double --> | This parameter is the x coordinate of center point that represents the center of the service area. | | + | * Description:N/A |
| - | | centerY | Double<!-- System.Double --> | This parameter is the y coordinate of center point that represents the center of the service area. | | + | |
| - | | drivingTime | TimeSpan<!-- System.TimeSpan --> | This parameter represents the time interval used to find the boundaries of the service area. | | + | |
| - | | averageSpeed | Single<!-- System.Single --> | This parameter represents the average speed traveled inside the service area. | | + | |
| - | | speedUnit | [[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]]<!-- ThinkGeo.MapSuite.Routing.SpeedUnit --> | This parameter represents the unit of average speed traveled inside the service area. | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | * //stops// |
| - | [[#Public Methods|Go Back]] | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]> |
| - | ==== GetAngleBetweenTwoLines(LineShape, LineShape) ==== | + | * Description:N/A |
| - | <!-- static --> | + | |
| - | This method returns the angle between two lines. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GetAngleBetweenTwoLines.28LineShape.2C_LineShape.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GetAngleBetweenTwoLines.28LineShape.2C_LineShape.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Double<!-- System.Double --> | The angle from first to the end line shape | | + | |
| - | === Parameters === | + | * //iterations// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Int32 |
| - | | fromLine | [[ThinkGeo.MapSuite.Core.LineShape|LineShape]]<!-- ThinkGeo.MapSuite.Core.LineShape --> | This parameter is the line that the angle is caucluated from | | + | * Description:N/A |
| - | | toLine | [[ThinkGeo.MapSuite.Core.LineShape|LineShape]]<!-- ThinkGeo.MapSuite.Core.LineShape --> | The parameter is the other line used to calculate the angle besed on the from line | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetRoute(String,IEnumerable<String>) ** |
| - | ==== GetDrivingDirection(LineShape, LineShape) ==== | + | |
| - | <!-- static --> | + | |
| - | This method returns the DrivingDirection based on the from line shape. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GetDrivingDirection.28LineShape.2C_LineShape.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GetDrivingDirection.28LineShape.2C_LineShape.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Routing.DrivingDirection|DrivingDirection]]<!-- ThinkGeo.MapSuite.Routing.DrivingDirection --> | The driving direction from the first to then end line shape. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | fromLine | [[ThinkGeo.MapSuite.Core.LineShape|LineShape]]<!-- ThinkGeo.MapSuite.Core.LineShape --> | This parameter is the line that DrivingDirection is caucluated from | | + | * //For the most updated Info for this topic, please check it here:// |
| - | | toLine | [[ThinkGeo.MapSuite.Core.LineShape|LineShape]]<!-- ThinkGeo.MapSuite.Core.LineShape --> | This parameter is the other line used to calculate the direction based on the from line shape | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]] |
| - | ==== 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.RoutingEngine#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GetHashCode.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //startFeatureId// |
| + | * Type:String | ||
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | * //stopFeatureIds// |
| - | [[#Public Methods|Go Back]] | + | * Type:IEnumerable<String> |
| - | ==== GetRoute(String, String, IEnumerable<String>, Int32) ==== | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]]<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetRoute(String,IEnumerable<String>,Int32) ** |
| - | | startFeatureId | String<!-- System.String --> | | | + | |
| - | | endFeatureId | String<!-- System.String --> | | | + | |
| - | | stopFeatureIds | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | | | + | |
| - | | iterations | Int32<!-- System.Int32 --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetRoute(String, String) ==== | + | * //For the most updated Info for this topic, please check it here:// |
| - | This method returns the routing path based on two feature IDs that represent two routeSegments. | + | |
| - | === Remarks === | + | |
| - | This method generates turn-by-turn driving directions for any route. It cannot be changed by overriding GetRouteCore.This method is for users who know the feature source. If the user does not know the feature source, they should use GetRouteSegments instead.This method is one of the most common routing requirements for a simple path, wherein a customer inputs two feature IDs that represent routeSegments and gets back a route. The route will be calculated from a specified start routeSegment to a specified end routeSegment. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]]<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]] |
| - | | startFeatureId | String<!-- System.String --> | This parameter is the start feature ID which represents a routeSegment for the start of the route. | | + | * Description:N/A |
| - | | endFeatureId | String<!-- System.String --> | This parameter is the end feature ID which represents a routeSegment for the end of the route. | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //startFeatureId// |
| - | ==== GetRoute(String, IEnumerable<String>, Int32) ==== | + | * Type:String |
| - | === Remarks === | + | * Description:N/A |
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]]<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> | | | + | |
| - | === Parameters === | + | * //stopFeatureIds// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| - | | startFeatureId | String<!-- System.String --> | | | + | * Description:N/A |
| - | | stopFeatureIds | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | | | + | |
| - | | iterations | Int32<!-- System.Int32 --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | * //iterations// |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GetRoute(String, IEnumerable<String>) ==== | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]]<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetRoute(String,String) ** |
| - | | startFeatureId | String<!-- System.String --> | | | + | |
| - | | stopFeatureIds | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | * //This method returns the routing path based on two feature IDs that represent two routeSegments.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetRoute(PointShape, PointShape, IEnumerable<PointShape>, Int32) ==== | + | * //This method generates turn-by-turn driving directions for any route. It cannot be changed by overriding GetRouteCore. This method is for users who know the feature source. If the user does not know the feature source, they should use GetRouteSegments instead. This method is one of the most common routing requirements for a simple path, wherein a customer inputs two feature IDs that represent routeSegments and gets back a route. The route will be calculated from a specified start routeSegment to a specified end routeSegment.// |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]]<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]] |
| - | | startPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | + | * Description:N/A |
| - | | endPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | + | |
| - | | stops | IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.PointShape} --> | | | + | |
| - | | iterations | Int32<!-- System.Int32 --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //startFeatureId// |
| - | ==== GetRoute(PointShape, PointShape, IEnumerable<PointShape>) ==== | + | * Type:String |
| - | === Remarks === | + | * Description:This parameter is the start feature ID which represents a routeSegment for the start of the route. |
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]]<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> | | | + | |
| - | === Parameters === | + | * //endFeatureId// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| - | | startPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | + | * Description:This parameter is the end feature ID which represents a routeSegment for the end of the route. |
| - | | endPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | + | |
| - | | stops | IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.PointShape} --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetRoute(String,String,IEnumerable<String>) ** |
| - | ==== GetRoute(PointShape, IEnumerable<PointShape>, Int32) ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]]<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | startPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | + | * //For the most updated Info for this topic, please check it here:// |
| - | | stops | IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.PointShape} --> | | | + | |
| - | | iterations | Int32<!-- System.Int32 --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]] |
| - | ==== GetRoute(PointShape, IEnumerable<PointShape>) ==== | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]]<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //startFeatureId// |
| - | | startPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | + | * Type:String |
| - | | stops | IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.PointShape} --> | | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | * //endFeatureId// |
| - | [[#Public Methods|Go Back]] | + | * Type:String |
| - | ==== GetRoute(PointShape, PointShape) ==== | + | * Description:N/A |
| - | This method returns the routing path based on two points. | + | |
| - | === Remarks === | + | |
| - | This method generates turn-by-turn driving directions for any route. It cannot be changed by overriding GetRouteCore.This method is for users who know the feature source. If the user does not know the feature source, they should use GetRouteSegments instead.This method is one of the most common routing requirements for a simple path, wherein a customer inputs two points and then finds a route. The route will be calculated from a specified start point to a specified end point. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]]<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> | | | + | |
| - | === Parameters === | + | * //stopFeatureIds// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| - | | startPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | This parameter is the start point which represents a routeSegment for the start of the route. | | + | * Description:N/A |
| - | | endPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | This parameter is the end point which represents a routeSegment for the end of the route. | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetRoute(String,String,IEnumerable<String>,Int32) ** |
| - | ==== GetRoute(String, String, IEnumerable<String>) ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]]<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | startFeatureId | String<!-- System.String --> | | | + | * //For the most updated Info for this topic, please check it here:// |
| - | | endFeatureId | String<!-- System.String --> | | | + | |
| - | | stopFeatureIds | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]] |
| - | ==== GetRouteSegments(String, String) ==== | + | * Description:N/A |
| - | This method returns a sequential routeSegments collection consisting of the route based on RoutingSource and does not use a FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This method for users who don't know the feature source. If the user knows the feature source, they should use GetRoute to get more information.This method is one of the most common routing requirements for a simple path, wherein a customer inputs two feature IDs that represent routeSegments and then finds a route. The route will be calculated from a specified start routeSegment to a specified end routeSegment. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Routing.RouteSegment} --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //startFeatureId// |
| - | | startFeatureId | String<!-- System.String --> | This parameter is the start point of the route. | | + | * Type:String |
| - | | endFeatureId | String<!-- System.String --> | This parameter is the end point of the route. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | * //endFeatureId// |
| - | [[#Public Methods|Go Back]] | + | * Type:String |
| - | ==== GetType() ==== | + | * 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.RoutingEngine#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GetType.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | * //stopFeatureIds// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | * //iterations// |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== ToString() ==== | + | * 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.RoutingEngine#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#ToString.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GenerateServiceArea(PointShape,TimeSpan) ** |
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ===== Protected Methods ===== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28PointShape.2C_TimeSpan.29// |
| - | ==== Finalize() ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#Finalize.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //centerPoint// |
| - | ==== GetRouteCore(String, String, IEnumerable<String>, Int32) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | === Remarks === | + | * Description:N/A |
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]]<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> | | | + | |
| - | === Parameters === | + | * //drivingTime// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:TimeSpan |
| - | | startFeatureId | String<!-- System.String --> | | | + | * Description:N/A |
| - | | endFeatureId | String<!-- System.String --> | | | + | |
| - | | stopFeatureIds | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | | | + | |
| - | | iterations | Int32<!-- System.Int32 --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GenerateServiceArea(PointShape,TimeSpan,Double,GeographyUnit) ** |
| - | ==== GetRouteCoreWithPoints(PointShape, PointShape, IEnumerable<PointShape>, Int32) ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]]<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | startPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28PointShape.2C_TimeSpan.2C_Double.2C_GeographyUnit.29// |
| - | | endPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | + | |
| - | | stops | IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.PointShape} --> | | | + | |
| - | | iterations | Int32<!-- System.Int32 --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] |
| - | ==== MemberwiseClone() ==== | + | * 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.RoutingEngine#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#MemberwiseClone.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //centerPoint// |
| + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | * //drivingTime// |
| - | [[#Protected Methods|Go Back]] | + | * Type:TimeSpan |
| - | ==== OnGeneratingServiceArea(GeneratingServiceAreaRoutingEngineEventArgs) ==== | + | * Description:N/A |
| - | This method allows you to raise the GeneratingServiceArea 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.RoutingEngine#OnGeneratingServiceArea.28GeneratingServiceAreaRoutingEngineEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#OnGeneratingServiceArea.28GeneratingServiceAreaRoutingEngineEventArgs.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //gridSize// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Double |
| - | | e | [[ThinkGeo.MapSuite.Routing.GeneratingServiceAreaRoutingEngineEventArgs|GeneratingServiceAreaRoutingEngineEventArgs]]<!-- ThinkGeo.MapSuite.Routing.GeneratingServiceAreaRoutingEngineEventArgs --> | | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | * //gridSizeUnit// |
| - | [[#Protected Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | ==== OnGettingRouteViaVisitStops(GettingRouteViaVisitStopsRoutingEngineEventArgs) ==== | + | * Description:N/A |
| - | This method allows you to raise the GetRouteViaVisitStops 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.RoutingEngine#OnGettingRouteViaVisitStops.28GettingRouteViaVisitStopsRoutingEngineEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#OnGettingRouteViaVisitStops.28GettingRouteViaVisitStopsRoutingEngineEventArgs.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GenerateServiceArea(String,TimeSpan) ** |
| - | | e | [[ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs|GettingRouteViaVisitStopsRoutingEngineEventArgs]]<!-- ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ===== Public Properties ===== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28String.2C_TimeSpan.29// |
| - | ==== DistanceUnit ==== | + | |
| - | Gets or sets a value that represents the distance unit of the route. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.2C_RoutingAlgorithm.2C_FeatureSource.2C_GeographyUnit.2C_DistanceUnit.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.2C_RoutingAlgorithm.2C_FeatureSource.2C_GeographyUnit.2C_DistanceUnit.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | == Return Value == |
| - | [[#Public Properties|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] |
| - | ==== FeatureSource ==== | + | * Description:N/A |
| - | Gets or sets a value that represents the FeatureSource used for finding the route. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.2C_FeatureSource.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.2C_FeatureSource.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]]<!-- ThinkGeo.MapSuite.Core.FeatureSource --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | == Parameters == |
| - | [[#Public Properties|Go Back]] | + | * //centerFeatureId// |
| - | ==== GeographyUnit ==== | + | * Type:String |
| - | Gets or sets a value that represents the geography unit of the FeatureSource. | + | * 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.RoutingEngine#RoutingEngine.28RoutingSource.2C_RoutingAlgorithm.2C_FeatureSource.2C_GeographyUnit.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.2C_RoutingAlgorithm.2C_FeatureSource.2C_GeographyUnit.29</a> | + | * //drivingTime// |
| - | === Return Value === | + | * Type:TimeSpan |
| - | ^ Return Type ^ | + | * Description:N/A |
| - | | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | | + | |
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GenerateServiceArea(String,TimeSpan,Double,GeographyUnit) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28String.2C_TimeSpan.2C_Double.2C_GeographyUnit.29// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //centerFeatureId// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | * //drivingTime// | ||
| + | * Type:TimeSpan | ||
| + | * Description:N/A | ||
| + | |||
| + | * //gridSize// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | * //gridSizeUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GenerateServiceArea(Double,Double,TimeSpan,Single,SpeedUnit) ** | ||
| + | |||
| + | * //This method returns a polygon that represents the service area around any location on a map.// | ||
| + | == Remarks == | ||
| + | * //You can define service ranges based on limits of speed and time. A service area is a region that encompasses all accessible routes (such as streets). The default geography unit for a feature source is decimal degrees. The default distance unit for the average speed is kilometers. For example, the 5-minute service area for a point includes all the streets that can be reached within five minutes from that point.// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] | ||
| + | * Description:A polygon that represents the service area. | ||
| + | |||
| + | == Parameters == | ||
| + | * //centerX// | ||
| + | * Type:Double | ||
| + | * Description:This parameter is the x coordinate of center point that represents the center of the service area. | ||
| + | |||
| + | * //centerY// | ||
| + | * Type:Double | ||
| + | * Description:This parameter is the y coordinate of center point that represents the center of the service area. | ||
| + | |||
| + | * //drivingTime// | ||
| + | * Type:TimeSpan | ||
| + | * Description:This parameter represents the time interval used to find the boundaries of the service area. | ||
| + | |||
| + | * //averageSpeed// | ||
| + | * Type:Single | ||
| + | * Description:This parameter represents the average speed traveled inside the service area. | ||
| + | |||
| + | * //speedUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]] | ||
| + | * Description:This parameter represents the unit of average speed traveled inside the service area. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GenerateServiceArea(PointShape,TimeSpan,Single,SpeedUnit) ** | ||
| + | |||
| + | * //This method returns a polygon that represents the service area around any location on a map.// | ||
| + | == Remarks == | ||
| + | * //You can define service ranges based on limits of speed and time. A service area is a region that encompasses all accessible routes (such as streets). The default geography unit for a feature source is decimal degrees. The default distance unit for the average speed is kilometers. For example, the 5-minute service area for a point includes all the streets that can be reached within five minutes from that point.// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] | ||
| + | * Description:A polygon that represents the service area. | ||
| + | |||
| + | == Parameters == | ||
| + | * //centerPoint// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| + | * Description:This parameter is the point that represents the center of the service area. | ||
| + | |||
| + | * //drivingTime// | ||
| + | * Type:TimeSpan | ||
| + | * Description:This parameter represents the time interval used to find the boundaries of the service area. | ||
| + | |||
| + | * //averageSpeed// | ||
| + | * Type:Single | ||
| + | * Description:This parameter represents the average speed traveled inside the service area. | ||
| + | |||
| + | * //speedUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]] | ||
| + | * Description:This parameter represents the unit of average speed traveled inside the service area. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GenerateServiceArea(PointShape,TimeSpan,Single,SpeedUnit,Double,GeographyUnit) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28PointShape.2C_TimeSpan.2C_Single.2C_SpeedUnit.2C_Double.2C_GeographyUnit.29// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //centerPoint// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //drivingTime// | ||
| + | * Type:TimeSpan | ||
| + | * Description:N/A | ||
| + | |||
| + | * //averageSpeed// | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | * //speedUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //gridSize// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | * //gridSizeUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GenerateServiceArea(String,TimeSpan,Single,SpeedUnit) ** | ||
| + | |||
| + | * //This method returns a polygon that represents the service area around any location on a map.// | ||
| + | == Remarks == | ||
| + | * //You can define service ranges based on limits of speed and time. A service area is a region that encompasses all accessible routes (such as streets). The default geography unit for a feature source is decimal degrees. The default distance unit for the average speed is kilometers. For example, the 5-minute service area for a point includes all the streets that can be reached within five minutes from that point.// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] | ||
| + | * Description:A polygon that represents the service area. | ||
| + | |||
| + | == Parameters == | ||
| + | * //centerFeatureId// | ||
| + | * Type:String | ||
| + | * Description:This parameter is the feature ID that represents the center of the service area. | ||
| + | |||
| + | * //drivingTime// | ||
| + | * Type:TimeSpan | ||
| + | * Description:This parameter represents the time interval used to find the boundaries of the service area. | ||
| + | |||
| + | * //averageSpeed// | ||
| + | * Type:Single | ||
| + | * Description:This parameter represents the average speed traveled inside the service area. | ||
| + | |||
| + | * //speedUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]] | ||
| + | * Description:This parameter represents the unit of average speed traveled inside the service area. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GenerateServiceArea(String,TimeSpan,Single,SpeedUnit,Double,GeographyUnit) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28String.2C_TimeSpan.2C_Single.2C_SpeedUnit.2C_Double.2C_GeographyUnit.29// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //centerFeatureId// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | * //drivingTime// | ||
| + | * Type:TimeSpan | ||
| + | * Description:N/A | ||
| + | |||
| + | * //averageSpeed// | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | * //speedUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.SpeedUnit|SpeedUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //gridSize// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | * //gridSizeUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <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.RoutingEngine#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.RoutingEngine#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.RoutingEngine#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.RoutingEngine#GetType.28.29// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Type | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetAngleBetweenTwoLines(LineShape,LineShape) ** | ||
| + | |||
| + | * //This method returns the angle between two lines.// | ||
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GetAngleBetweenTwoLines.28LineShape.2C_LineShape.29// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Double | ||
| + | * Description:The angle from first to the end line shape | ||
| + | |||
| + | == Parameters == | ||
| + | * //fromLine// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.LineShape|LineShape]] | ||
| + | * Description:This parameter is the line that the angle is caucluated from | ||
| + | |||
| + | * //toLine// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.LineShape|LineShape]] | ||
| + | * Description:The parameter is the other line used to calculate the angle besed on the from line | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetDrivingDirection(LineShape,LineShape) ** | ||
| + | |||
| + | * //This method returns the DrivingDirection based on the from line shape.// | ||
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GetDrivingDirection.28LineShape.2C_LineShape.29// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.DrivingDirection|DrivingDirection]] | ||
| + | * Description:The driving direction from the first to then end line shape. | ||
| + | |||
| + | == Parameters == | ||
| + | * //fromLine// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.LineShape|LineShape]] | ||
| + | * Description:This parameter is the line that DrivingDirection is caucluated from | ||
| + | |||
| + | * //toLine// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.LineShape|LineShape]] | ||
| + | * Description:This parameter is the other line used to calculate the direction based on the from line shape | ||
| + | |||
| + | <div newline></div> | ||
| + | ==== Protected Methods ==== | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetRouteCore(String,String,IEnumerable<String>,Int32) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //startFeatureId// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | * //endFeatureId// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | * //stopFeatureIds// | ||
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| + | |||
| + | * //iterations// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetRouteCoreWithPoints(PointShape,PointShape,IEnumerable<PointShape>,Int32) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingResult|RoutingResult]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //startPoint// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //endPoint// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //stops// | ||
| + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]> | ||
| + | * Description:N/A | ||
| + | |||
| + | * //iterations// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} OnGettingRouteViaVisitStops(GettingRouteViaVisitStopsRoutingEngineEventArgs) ** | ||
| + | |||
| + | * //This method allows you to raise the GetRouteViaVisitStops 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.RoutingEngine#OnGettingRouteViaVisitStops.28GettingRouteViaVisitStopsRoutingEngineEventArgs.29// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //e// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs|GettingRouteViaVisitStopsRoutingEngineEventArgs]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} OnGeneratingServiceArea(GeneratingServiceAreaRoutingEngineEventArgs) ** | ||
| + | |||
| + | * //This method allows you to raise the GeneratingServiceArea 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.RoutingEngine#OnGeneratingServiceArea.28GeneratingServiceAreaRoutingEngineEventArgs.29// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //e// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.GeneratingServiceAreaRoutingEngineEventArgs|GeneratingServiceAreaRoutingEngineEventArgs]] | ||
| + | * 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.RoutingEngine#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.RoutingEngine#MemberwiseClone.28.29// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ==== Public Properties ==== | ||
| + | ** {{wiki:PublicProperty.gif|}} RoutingAlgorithm ** | ||
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RoutingAlgorithm ==== | ||
| Gets or sets a value that represents the routingAlgorithm used for finding the route. | Gets or sets a value that represents the routingAlgorithm used for finding the route. | ||
| - | === Remarks === | + | == Remarks == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.2C_RoutingAlgorithm.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.2C_RoutingAlgorithm.29</a> | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.2C_RoutingAlgorithm.29 |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]] |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingAlgorithm|RoutingAlgorithm]]<!-- ThinkGeo.MapSuite.Routing.RoutingAlgorithm --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | ** {{wiki:PublicProperty.gif|}} RoutingSource ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== RoutingResultsType ==== | + | |
| - | Gets or sets a value that represents how much data is returned in the routing results. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingResultsType" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingResultsType</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingResultsType|RoutingResultsType]]<!-- ThinkGeo.MapSuite.Routing.RoutingResultsType --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RoutingSource ==== | ||
| Gets or sets a routingSource object for finding the route. | Gets or sets a routingSource object for finding the route. | ||
| - | === Remarks === | + | == Remarks == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.29</a> | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.29 |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]] |
| - | | [[ThinkGeo.MapSuite.Routing.RoutingSource|RoutingSource]]<!-- ThinkGeo.MapSuite.Routing.RoutingSource --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | ** {{wiki:PublicProperty.gif|}} GeographyUnit ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | Gets or sets a value that represents the geography unit of the FeatureSource. |
| - | ===== Public Events ===== | + | == Remarks == |
| - | ==== GeneratingServiceArea ==== | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.2C_RoutingAlgorithm.2C_FeatureSource.2C_GeographyUnit.29 |
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} DistanceUnit ** | ||
| + | |||
| + | Gets or sets a value that represents the distance unit of the route. | ||
| + | == Remarks == | ||
| + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.2C_RoutingAlgorithm.2C_FeatureSource.2C_GeographyUnit.2C_DistanceUnit.29 | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} FeatureSource ** | ||
| + | |||
| + | Gets or sets a value that represents the FeatureSource used for finding the route. | ||
| + | == Remarks == | ||
| + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.2C_FeatureSource.29 | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} RoutingResultsType ** | ||
| + | |||
| + | Gets or sets a value that represents how much data is returned in the routing results. | ||
| + | == Remarks == | ||
| + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingResultsType | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.RoutingResultsType|RoutingResultsType]] | ||
| + | |||
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||
| + | ** {{wiki:PublicEvent.gif|}} GeneratingServiceArea ** | ||
| This event is called during the generating service area. | This event is called during the generating service area. | ||
| - | === Remarks === | + | == Remarks == |
| This event is called during the generating service area. It wil be called many times during call the GenerateServiceArea method. | This event is called during the generating service area. It wil be called many times during call the GenerateServiceArea method. | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.Routing.GeneratingServiceAreaRoutingEngineEventArgs|GeneratingServiceAreaRoutingEngineEventArgs]]<!-- ThinkGeo.MapSuite.Routing.GeneratingServiceAreaRoutingEngineEventArgs --> | | ||
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | Event Arguments:[[ThinkGeo.MapSuite.Routing.GeneratingServiceAreaRoutingEngineEventArgs|GeneratingServiceAreaRoutingEngineEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | ==== GettingRouteViaVisitStops ==== | + | ** {{wiki:PublicEvent.gif|}} GettingRouteViaVisitStops ** |
| This event is called during the calculating best visit sequence | This event is called during the calculating best visit sequence | ||
| - | === Remarks === | + | == Remarks == |
| This event is called during the calculating best visit sequence. It wil be called many times during calling the GetRouteViaVisitStops method. | This event is called during the calculating best visit sequence. It wil be called many times during calling the GetRouteViaVisitStops method. | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs|GettingRouteViaVisitStopsRoutingEngineEventArgs]]<!-- ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs --> | | ||
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingEngine --> | + | Event Arguments:[[ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs|GettingRouteViaVisitStopsRoutingEngineEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | __NOTOC__ | ||
| - | [[Category:MapSuiteRouting]] | ||
| - | [[Category:ThinkGeo.MapSuite.Routing]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.routing.routingengine.1440040134.txt.gz · Last modified: 2015/09/22 08:32 (external edit)