User Tools

Site Tools

Trace: • thinkgeo.mapsuite.routing.routingengine

Sidebar

ThinkGeo Cloud

ThinkGeo UI Controls

ThinkGeo Open Source

Help and Support

External Resources

thinkgeo.mapsuite.routing.routingengine

Table of Contents

ThinkGeo.MapSuite.Routing.RoutingEngine

Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.

This class is for finding a route.

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Routing.RoutingEngine

Members Summary

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

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

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

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

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

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

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

Protected Constructors

Public Methods

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
Parameters
  • startFeatureId
    • Type:String
    • Description:This parameter is the start point of the route.
  • endFeatureId
    • Type:String
    • Description:This parameter is the end point of the route.

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
Parameters
  • startPoint
    • Type:PointShape
    • Description:This parameter is the start point which represents a routeSegment for the start of the route.
  • endPoint
    • Type:PointShape
    • Description:This parameter is the end point which represents a routeSegment for the end of the route.

GetRoute(PointShape,IEnumerable<PointShape>)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
Parameters
  • stops

GetRoute(PointShape,IEnumerable<PointShape>,Int32)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
Parameters
  • stops
  • iterations
    • Type:Int32
    • Description:N/A

GetRoute(PointShape,PointShape,IEnumerable<PointShape>)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
Parameters
  • stops

GetRoute(PointShape,PointShape,IEnumerable<PointShape>,Int32)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
Parameters
  • stops
  • iterations
    • Type:Int32
    • Description:N/A

GetRoute(String,IEnumerable<String>)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
Parameters
  • startFeatureId
    • Type:String
    • Description:N/A
  • stopFeatureIds
    • Type:IEnumerable<String>
    • Description:N/A

GetRoute(String,IEnumerable<String>,Int32)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
Parameters
  • startFeatureId
    • Type:String
    • Description:N/A
  • stopFeatureIds
    • Type:IEnumerable<String>
    • Description:N/A
  • iterations
    • Type:Int32
    • Description:N/A

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
Parameters
  • startFeatureId
    • Type:String
    • Description:This parameter is the start feature ID which represents a routeSegment for the start of the route.
  • endFeatureId
    • Type:String
    • Description:This parameter is the end feature ID which represents a routeSegment for the end of the route.

GetRoute(String,String,IEnumerable<String>)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
Parameters
  • startFeatureId
    • Type:String
    • Description:N/A
  • endFeatureId
    • Type:String
    • Description:N/A
  • stopFeatureIds
    • Type:IEnumerable<String>
    • Description:N/A

GetRoute(String,String,IEnumerable<String>,Int32)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
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

GenerateServiceArea(PointShape,TimeSpan)

  • 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.29
Return Value
Parameters
  • drivingTime
    • Type:TimeSpan
    • Description:N/A

GenerateServiceArea(PointShape,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.28PointShape.2C_TimeSpan.2C_Double.2C_GeographyUnit.29
Return Value
Parameters
  • drivingTime
    • Type:TimeSpan
    • Description:N/A
  • gridSize
    • Type:Double
    • Description:N/A

GenerateServiceArea(String,TimeSpan)

  • 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.29
Return Value
Parameters
  • centerFeatureId
    • Type:String
    • Description:N/A
  • drivingTime
    • Type:TimeSpan
    • Description:N/A

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
Parameters
  • centerFeatureId
    • Type:String
    • Description:N/A
  • drivingTime
    • Type:TimeSpan
    • Description:N/A
  • gridSize
    • Type:Double
    • Description:N/A

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: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:SpeedUnit
    • Description:This parameter represents the unit of average speed traveled inside the service area.

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:PolygonShape
  • Description:A polygon that represents the service area.
Parameters
  • centerPoint
    • Type: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:SpeedUnit
    • Description:This parameter represents the unit of average speed traveled inside the service area.

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
Parameters
  • drivingTime
    • Type:TimeSpan
    • Description:N/A
  • averageSpeed
    • Type:Single
    • Description:N/A
  • gridSize
    • Type:Double
    • Description:N/A

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: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:SpeedUnit
    • Description:This parameter represents the unit of average speed traveled inside the service area.

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
Parameters
  • centerFeatureId
    • Type:String
    • Description:N/A
  • drivingTime
    • Type:TimeSpan
    • Description:N/A
  • averageSpeed
    • Type:Single
    • Description:N/A
  • gridSize
    • Type:Double
    • Description:N/A

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

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

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

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

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:LineShape
    • Description:This parameter is the line that the angle is caucluated from
  • toLine
    • Type:LineShape
    • Description:The parameter is the other line used to calculate the angle besed on the from line

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:DrivingDirection
  • Description:The driving direction from the first to then end line shape.
Parameters
  • fromLine
    • Type:LineShape
    • Description:This parameter is the line that DrivingDirection is caucluated from
  • toLine
    • Type:LineShape
    • Description:This parameter is the other line used to calculate the direction based on the from line shape

Protected Methods

GetRouteCore(String,String,IEnumerable<String>,Int32)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
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

GetRouteCoreWithPoints(PointShape,PointShape,IEnumerable<PointShape>,Int32)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
Parameters
  • stops
  • iterations
    • Type:Int32
    • Description:N/A

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

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

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

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

Public Properties

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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.2C_RoutingAlgorithm.29

Return Value

RoutingSource

Gets or sets a routingSource object 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.29

Return Value

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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingEngine#RoutingEngine.28RoutingSource.2C_RoutingAlgorithm.2C_FeatureSource.2C_GeographyUnit.29

Return Value

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

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

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

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:GeneratingServiceAreaRoutingEngineEventArgs

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:GettingRouteViaVisitStopsRoutingEngineEventArgs

thinkgeo.mapsuite.routing.routingengine.txt · Last modified: 2017/03/16 21:59 (external edit)

Page Tools