ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.routing.routingengine
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.Routing.RoutingEngine
<!– Class –> 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
*System.Object **ThinkGeo.MapSuite.Routing.RoutingEngine
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 RoutingEngine | This is a constructor for the class. | ||
| RoutingEngine | RoutingSource | This is a constructor for the class. | |
| RoutingEngine | RoutingSource, FeatureSource | This is a constructor for the class. | |
| RoutingEngine | RoutingSource, RoutingAlgorithm | This is a constructor for the class. | |
| RoutingEngine | RoutingSource, RoutingAlgorithm, FeatureSource | This is a constructor for the class. | |
| RoutingEngine | RoutingSource, RoutingAlgorithm, FeatureSource, GeographyUnit | This is a constructor for the class. | |
| RoutingEngine | RoutingSource, RoutingAlgorithm, FeatureSource, GeographyUnit, DistanceUnit | This is a constructor for the class. |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| Equals | Object | Object | |
| GenerateServiceArea | String, TimeSpan, Single, SpeedUnit, Double, GeographyUnit | ||
| GenerateServiceArea | String, TimeSpan, Single, SpeedUnit | This method returns a polygon that represents the service area around any location on a map. | |
| GenerateServiceArea | PointShape, TimeSpan, Single, SpeedUnit, Double, GeographyUnit | ||
| GenerateServiceArea | PointShape, TimeSpan, Single, SpeedUnit | This method returns a polygon that represents the service area around any location on a map. | |
| GenerateServiceArea | String, TimeSpan, Double, GeographyUnit | ||
| GenerateServiceArea | String, TimeSpan | ||
| GenerateServiceArea | PointShape, TimeSpan | ||
| GenerateServiceArea | PointShape, TimeSpan, Double, GeographyUnit | ||
| GenerateServiceArea | Double, Double, TimeSpan, Single, SpeedUnit | This method returns a polygon that represents the service area around any location on a map. | |
 GetAngleBetweenTwoLines | LineShape, LineShape | This method returns the angle between two lines. | |
| GetDrivingDirection | LineShape, LineShape | This method returns the DrivingDirection based on the from line shape. | |
| GetHashCode | Object | ||
| GetRoute | String, String, IEnumerable<String>, Int32 | ||
| GetRoute | String, String | This method returns the routing path based on two feature IDs that represent two routeSegments. | |
| GetRoute | String, IEnumerable<String>, Int32 | ||
| GetRoute | String, IEnumerable<String> | ||
| GetRoute | PointShape, PointShape, IEnumerable<PointShape>, Int32 | ||
| GetRoute | PointShape, PointShape, IEnumerable<PointShape> | ||
| GetRoute | PointShape, IEnumerable<PointShape>, Int32 | ||
| GetRoute | PointShape, IEnumerable<PointShape> | ||
| GetRoute | PointShape, PointShape | This method returns the routing path based on two points. | |
| GetRoute | String, String, IEnumerable<String> | ||
| GetRouteSegments | String, String | This method returns a sequential routeSegments collection consisting of the route based on RoutingSource and does not use a FeatureSource. | |
| GetType | Object | ||
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Finalize | Object | ||
| GetRouteCore | String, String, IEnumerable<String>, Int32 | ||
| GetRouteCoreWithPoints | PointShape, PointShape, IEnumerable<PointShape>, Int32 | ||
| MemberwiseClone | Object | ||
| OnGeneratingServiceArea | GeneratingServiceAreaRoutingEngineEventArgs | This method allows you to raise the GeneratingServiceArea event from a derived class. | |
| OnGettingRouteViaVisitStops | GettingRouteViaVisitStopsRoutingEngineEventArgs | This method allows you to raise the GetRouteViaVisitStops event from a derived class. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 DistanceUnit | DistanceUnit | Gets or sets a value that represents the distance unit of the route. | |
| FeatureSource | FeatureSource | Gets or sets a value that represents the FeatureSource used for finding the route. | |
| GeographyUnit | GeographyUnit | Gets or sets a value that represents the geography unit of the FeatureSource. | |
| RoutingAlgorithm | RoutingAlgorithm | Gets or sets a value that represents the routingAlgorithm used for finding the route. | |
| RoutingResultsType | RoutingResultsType | Gets or sets a value that represents how much data is returned in the routing results. | |
| RoutingSource | RoutingSource | Gets or sets a routingSource object for finding the route. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|---|---|---|
 GeneratingServiceArea | GeneratingServiceAreaRoutingEngineEventArgs | This event is called during the generating service area. | |
| GettingRouteViaVisitStops | GettingRouteViaVisitStopsRoutingEngineEventArgs | This event is called during the calculating best visit sequence |
Public Constructors
RoutingEngine()
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 |
|---|
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
| Name | Type | Description |
|---|---|---|
| routingSource | RoutingSource<!– ThinkGeo.MapSuite.Routing.RoutingSource –> |
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
| Name | Type | Description |
|---|---|---|
| routingSource | RoutingSource<!– ThinkGeo.MapSuite.Routing.RoutingSource –> | |
| featureSource | FeatureSource<!– ThinkGeo.MapSuite.Core.FeatureSource –> |
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
| Name | Type | Description |
|---|---|---|
| routingSource | RoutingSource<!– ThinkGeo.MapSuite.Routing.RoutingSource –> | |
| routingAlgorithm | RoutingAlgorithm<!– ThinkGeo.MapSuite.Routing.RoutingAlgorithm –> |
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
| Name | Type | Description |
|---|---|---|
| routingSource | RoutingSource<!– ThinkGeo.MapSuite.Routing.RoutingSource –> | |
| routingAlgorithm | RoutingAlgorithm<!– ThinkGeo.MapSuite.Routing.RoutingAlgorithm –> | |
| featureSource | FeatureSource<!– ThinkGeo.MapSuite.Core.FeatureSource –> |
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
| Name | Type | Description |
|---|---|---|
| routingSource | RoutingSource<!– ThinkGeo.MapSuite.Routing.RoutingSource –> | |
| routingAlgorithm | RoutingAlgorithm<!– ThinkGeo.MapSuite.Routing.RoutingAlgorithm –> | |
| featureSource | FeatureSource<!– ThinkGeo.MapSuite.Core.FeatureSource –> | |
| geographyUnit | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> |
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
| Name | Type | Description |
|---|---|---|
| routingSource | RoutingSource<!– ThinkGeo.MapSuite.Routing.RoutingSource –> | |
| routingAlgorithm | RoutingAlgorithm<!– ThinkGeo.MapSuite.Routing.RoutingAlgorithm –> | |
| featureSource | FeatureSource<!– ThinkGeo.MapSuite.Core.FeatureSource –> | |
| geographyUnit | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | |
| distanceUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> |
Protected Constructors
Public Methods
Equals(Object)
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.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
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
GenerateServiceArea(String, TimeSpan, Single, SpeedUnit, Double, GeographyUnit)
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 |
|---|---|
| PolygonShape<!– ThinkGeo.MapSuite.Core.PolygonShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| centerFeatureId | String<!– System.String –> | |
| drivingTime | TimeSpan<!– System.TimeSpan –> | |
| averageSpeed | Single<!– System.Single –> | |
| speedUnit | SpeedUnit<!– ThinkGeo.MapSuite.Routing.SpeedUnit –> | |
| gridSize | Double<!– System.Double –> | |
| gridSizeUnit | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
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
| Return Type | Description |
|---|---|
| PolygonShape<!– ThinkGeo.MapSuite.Core.PolygonShape –> | A polygon that represents the service area. |
Parameters
| Name | Type | Description |
|---|---|---|
| centerFeatureId | String<!– System.String –> | This parameter is the feature ID 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 | SpeedUnit<!– ThinkGeo.MapSuite.Routing.SpeedUnit –> | This parameter represents the unit of average speed traveled inside the service area. |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GenerateServiceArea(PointShape, TimeSpan, Single, SpeedUnit, Double, GeographyUnit)
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_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 |
|---|---|
| PolygonShape<!– ThinkGeo.MapSuite.Core.PolygonShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| centerPoint | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| drivingTime | TimeSpan<!– System.TimeSpan –> | |
| averageSpeed | Single<!– System.Single –> | |
| speedUnit | SpeedUnit<!– ThinkGeo.MapSuite.Routing.SpeedUnit –> | |
| gridSize | Double<!– System.Double –> | |
| gridSizeUnit | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
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
| Return Type | Description |
|---|---|
| PolygonShape<!– ThinkGeo.MapSuite.Core.PolygonShape –> | A polygon that represents the service area. |
Parameters
| Name | Type | Description |
|---|---|---|
| centerPoint | 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 | SpeedUnit<!– ThinkGeo.MapSuite.Routing.SpeedUnit –> | This parameter represents the unit of average speed traveled inside the service area. |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GenerateServiceArea(String, TimeSpan, Double, GeographyUnit)
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 |
|---|---|
| PolygonShape<!– ThinkGeo.MapSuite.Core.PolygonShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| centerFeatureId | String<!– System.String –> | |
| drivingTime | TimeSpan<!– System.TimeSpan –> | |
| gridSize | Double<!– System.Double –> | |
| gridSizeUnit | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GenerateServiceArea(String, TimeSpan)
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.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#GenerateServiceArea.28String.2C_TimeSpan.29</a>
Return Value
| Return Type | Description |
|---|---|
| PolygonShape<!– ThinkGeo.MapSuite.Core.PolygonShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| centerFeatureId | String<!– System.String –> | |
| drivingTime | TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GenerateServiceArea(PointShape, TimeSpan)
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 |
|---|---|
| PolygonShape<!– ThinkGeo.MapSuite.Core.PolygonShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| centerPoint | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| drivingTime | TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GenerateServiceArea(PointShape, TimeSpan, Double, GeographyUnit)
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 |
|---|---|
| PolygonShape<!– ThinkGeo.MapSuite.Core.PolygonShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| centerPoint | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| drivingTime | TimeSpan<!– System.TimeSpan –> | |
| gridSize | Double<!– System.Double –> | |
| gridSizeUnit | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
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
| Return Type | Description |
|---|---|
| PolygonShape<!– ThinkGeo.MapSuite.Core.PolygonShape –> | A polygon that represents the service area. |
Parameters
| Name | Type | Description |
|---|---|---|
| centerX | Double<!– System.Double –> | This parameter is the x coordinate of center point that represents the center of the service area. |
| 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 | SpeedUnit<!– ThinkGeo.MapSuite.Routing.SpeedUnit –> | This parameter represents the unit of average speed traveled inside the service area. |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GetAngleBetweenTwoLines(LineShape, LineShape)
<!– 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
| Name | Type | Description |
|---|---|---|
| fromLine | LineShape<!– ThinkGeo.MapSuite.Core.LineShape –> | This parameter is the line that the angle is caucluated from |
| toLine | 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 –> Go Back
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 |
|---|---|
| DrivingDirection<!– ThinkGeo.MapSuite.Routing.DrivingDirection –> | The driving direction from the first to then end line shape. |
Parameters
| Name | Type | Description |
|---|---|---|
| fromLine | LineShape<!– ThinkGeo.MapSuite.Core.LineShape –> | This parameter is the line that DrivingDirection is caucluated from |
| toLine | 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 –> Go Back
GetHashCode()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.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
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetRoute(String, String, IEnumerable<String>, Int32)
Remarks
For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>
Return Value
| Return Type | Description |
|---|---|
| RoutingResult<!– ThinkGeo.MapSuite.Routing.RoutingResult –> |
Parameters
| Name | Type | Description |
|---|---|---|
| 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 –> Go Back
GetRoute(String, String)
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 |
|---|---|
| RoutingResult<!– ThinkGeo.MapSuite.Routing.RoutingResult –> |
Parameters
| Name | Type | Description |
|---|---|---|
| startFeatureId | String<!– System.String –> | This parameter is the start feature ID which represents a routeSegment for the start of the route. |
| 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 –> Go Back
GetRoute(String, IEnumerable<String>, Int32)
Remarks
For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>
Return Value
| Return Type | Description |
|---|---|
| RoutingResult<!– ThinkGeo.MapSuite.Routing.RoutingResult –> |
Parameters
| Name | Type | Description |
|---|---|---|
| startFeatureId | String<!– System.String –> | |
| stopFeatureIds | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> | |
| iterations | Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GetRoute(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 |
|---|---|
| RoutingResult<!– ThinkGeo.MapSuite.Routing.RoutingResult –> |
Parameters
| Name | Type | Description |
|---|---|---|
| startFeatureId | String<!– System.String –> | |
| stopFeatureIds | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GetRoute(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 |
|---|---|
| RoutingResult<!– ThinkGeo.MapSuite.Routing.RoutingResult –> |
Parameters
| Name | Type | Description |
|---|---|---|
| startPoint | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| endPoint | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| stops | IEnumerable<PointShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.PointShape} –> | |
| iterations | Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GetRoute(PointShape, PointShape, IEnumerable<PointShape>)
Remarks
For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>
Return Value
| Return Type | Description |
|---|---|
| RoutingResult<!– ThinkGeo.MapSuite.Routing.RoutingResult –> |
Parameters
| Name | Type | Description |
|---|---|---|
| startPoint | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| endPoint | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| stops | IEnumerable<PointShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.PointShape} –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
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 |
|---|---|
| RoutingResult<!– ThinkGeo.MapSuite.Routing.RoutingResult –> |
Parameters
| Name | Type | Description |
|---|---|---|
| startPoint | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| stops | IEnumerable<PointShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.PointShape} –> | |
| iterations | Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GetRoute(PointShape, IEnumerable<PointShape>)
Remarks
For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>
Return Value
| Return Type | Description |
|---|---|
| RoutingResult<!– ThinkGeo.MapSuite.Routing.RoutingResult –> |
Parameters
| Name | Type | Description |
|---|---|---|
| startPoint | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| stops | IEnumerable<PointShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.PointShape} –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GetRoute(PointShape, PointShape)
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 |
|---|---|
| RoutingResult<!– ThinkGeo.MapSuite.Routing.RoutingResult –> |
Parameters
| Name | Type | Description |
|---|---|---|
| startPoint | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | This parameter is the start point which represents a routeSegment for the start of the route. |
| endPoint | 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 –> Go Back
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 |
|---|---|
| RoutingResult<!– ThinkGeo.MapSuite.Routing.RoutingResult –> |
Parameters
| Name | Type | Description |
|---|---|---|
| startFeatureId | String<!– System.String –> | |
| endFeatureId | String<!– System.String –> | |
| stopFeatureIds | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GetRouteSegments(String, String)
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<RouteSegment><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Routing.RouteSegment} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| startFeatureId | String<!– System.String –> | This parameter is the start point of the route. |
| endFeatureId | String<!– System.String –> | This parameter is the end point of the route. |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GetType()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.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
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
ToString()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.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
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
Finalize()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.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
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetRouteCore(String, String, IEnumerable<String>, Int32)
Remarks
For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>
Return Value
| Return Type | Description |
|---|---|
| RoutingResult<!– ThinkGeo.MapSuite.Routing.RoutingResult –> |
Parameters
| Name | Type | Description |
|---|---|---|
| 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 –> Go Back
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 |
|---|---|
| RoutingResult<!– ThinkGeo.MapSuite.Routing.RoutingResult –> |
Parameters
| Name | Type | Description |
|---|---|---|
| startPoint | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| endPoint | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| stops | IEnumerable<PointShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.PointShape} –> | |
| iterations | Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
MemberwiseClone()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.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
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
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:<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
| Name | Type | Description |
|---|---|---|
| e | GeneratingServiceAreaRoutingEngineEventArgs<!– ThinkGeo.MapSuite.Routing.GeneratingServiceAreaRoutingEngineEventArgs –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
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:<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
| Name | Type | Description |
|---|---|---|
| e | GettingRouteViaVisitStopsRoutingEngineEventArgs<!– ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
Public Properties
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 |
|---|
| DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
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:<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 |
|---|
| FeatureSource<!– ThinkGeo.MapSuite.Core.FeatureSource –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GeographyUnit
Gets or sets a value that represents the geography unit of the FeatureSource.
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>
Return Value
| Return Type |
|---|
| GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
RoutingAlgorithm
Gets or sets a value that represents the routingAlgorithm 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_RoutingAlgorithm.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.2C_RoutingAlgorithm.29</a>
Return Value
| Return Type |
|---|
| RoutingAlgorithm<!– ThinkGeo.MapSuite.Routing.RoutingAlgorithm –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> 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 |
|---|
| RoutingResultsType<!– ThinkGeo.MapSuite.Routing.RoutingResultsType –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
RoutingSource
Gets or sets a routingSource object 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.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.29</a>
Return Value
| Return Type |
|---|
| RoutingSource<!– ThinkGeo.MapSuite.Routing.RoutingSource –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
Protected Properties
Public Events
GeneratingServiceArea
This event is called during the generating service area.
Remarks
This event is called during the generating service area. It wil be called many times during call the GenerateServiceArea method.
Event Arguments
| Event Arguments |
|---|
| GeneratingServiceAreaRoutingEngineEventArgs<!– ThinkGeo.MapSuite.Routing.GeneratingServiceAreaRoutingEngineEventArgs –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
GettingRouteViaVisitStops
This event is called during the calculating best visit sequence
Remarks
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 |
|---|
| GettingRouteViaVisitStopsRoutingEngineEventArgs<!– ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs –> |
<!– ThinkGeo.MapSuite.Routing.RoutingEngine –> Go Back
NOTOC MapSuiteRouting ThinkGeo.MapSuite.Routing UpdateDocumentation
thinkgeo.mapsuite.routing.routingengine.1440040134.txt.gz · Last modified: 2015/09/22 08:32 (external edit)