Table of Contents
ThinkGeo.MapSuite.Routing.RoutingEngine
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
- routingSource
- Type:RoutingSource
- Description:N/A
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:RoutingSource
- Description:N/A
- featureSource
- Type:FeatureSource
- Description:N/A
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:RoutingSource
- Description:N/A
- routingAlgorithm
- Type:RoutingAlgorithm
- Description:N/A
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:RoutingSource
- Description:N/A
- routingAlgorithm
- Type:RoutingAlgorithm
- Description:N/A
- featureSource
- Type:FeatureSource
- Description:N/A
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:RoutingSource
- Description:N/A
- routingAlgorithm
- Type:RoutingAlgorithm
- Description:N/A
- featureSource
- Type:FeatureSource
- Description:N/A
- geographyUnit
- Type:GeographyUnit
- Description:N/A
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:RoutingSource
- Description:N/A
- routingAlgorithm
- Type:RoutingAlgorithm
- Description:N/A
- featureSource
- Type:FeatureSource
- Description:N/A
- geographyUnit
- Type:GeographyUnit
- Description:N/A
- distanceUnit
- Type:DistanceUnit
- Description:N/A
Protected Constructors
Public Methods
GetRouteSegments(String,String)
- N/A
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
- Type:Collection<RouteSegment>
- Description:N/A
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)
- N/A
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
- Type:RoutingResult
- Description:N/A
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
- N/A
Return Value
- Type:RoutingResult
- Description:N/A
Parameters
- startPoint
- Type:PointShape
- Description:N/A
- stops
- Type:IEnumerable<PointShape>
- Description:N/A
GetRoute(PointShape,IEnumerable<PointShape>,Int32)
- N/A
Remarks
- N/A
Return Value
- Type:RoutingResult
- Description:N/A
Parameters
- startPoint
- Type:PointShape
- Description:N/A
- stops
- Type:IEnumerable<PointShape>
- Description:N/A
- iterations
- Type:Int32
- Description:N/A
GetRoute(PointShape,PointShape,IEnumerable<PointShape>)
- N/A
Remarks
- N/A
Return Value
- Type:RoutingResult
- Description:N/A
Parameters
- startPoint
- Type:PointShape
- Description:N/A
- endPoint
- Type:PointShape
- Description:N/A
- stops
- Type:IEnumerable<PointShape>
- Description:N/A
GetRoute(PointShape,PointShape,IEnumerable<PointShape>,Int32)
- N/A
Remarks
- N/A
Return Value
- Type:RoutingResult
- Description:N/A
Parameters
- startPoint
- Type:PointShape
- Description:N/A
- endPoint
- Type:PointShape
- Description:N/A
- stops
- Type:IEnumerable<PointShape>
- Description:N/A
- iterations
- Type:Int32
- Description:N/A
GetRoute(String,IEnumerable<String>)
- N/A
Remarks
- N/A
Return Value
- Type:RoutingResult
- Description:N/A
Parameters
- startFeatureId
- Type:String
- Description:N/A
- stopFeatureIds
- Type:IEnumerable<String>
- Description:N/A
GetRoute(String,IEnumerable<String>,Int32)
- N/A
Remarks
- N/A
Return Value
- Type:RoutingResult
- Description:N/A
Parameters
- startFeatureId
- Type:String
- Description:N/A
- stopFeatureIds
- Type:IEnumerable<String>
- Description:N/A
- iterations
- Type:Int32
- Description:N/A
GetRoute(String,String)
- N/A
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
- Type:RoutingResult
- Description:N/A
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
- N/A
Return Value
- Type:RoutingResult
- Description:N/A
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
- N/A
Return Value
- Type: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
GenerateServiceArea(PointShape,TimeSpan)
- N/A
Remarks
- N/A
Return Value
- Type:PolygonShape
- Description:N/A
Parameters
- centerPoint
- Type:PointShape
- Description:N/A
- drivingTime
- Type:TimeSpan
- Description:N/A
GenerateServiceArea(PointShape,TimeSpan,Double,GeographyUnit)
- N/A
Remarks
- N/A
Return Value
- Type:PolygonShape
- Description:N/A
Parameters
- centerPoint
- Type:PointShape
- Description:N/A
- drivingTime
- Type:TimeSpan
- Description:N/A
- gridSize
- Type:Double
- Description:N/A
- gridSizeUnit
- Type:GeographyUnit
- Description:N/A
GenerateServiceArea(String,TimeSpan)
- N/A
Remarks
- N/A
Return Value
- Type:PolygonShape
- Description:N/A
Parameters
- centerFeatureId
- Type:String
- Description:N/A
- drivingTime
- Type:TimeSpan
- Description:N/A
GenerateServiceArea(String,TimeSpan,Double,GeographyUnit)
- N/A
Remarks
- N/A
Return Value
- Type: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:GeographyUnit
- Description:N/A
GenerateServiceArea(Double,Double,TimeSpan,Single,SpeedUnit)
- 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
- 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)
- N/A
Remarks
- N/A
Return Value
- Type:PolygonShape
- Description:N/A
Parameters
- centerPoint
- Type:PointShape
- Description:N/A
- drivingTime
- Type:TimeSpan
- Description:N/A
- averageSpeed
- Type:Single
- Description:N/A
- speedUnit
- Type:SpeedUnit
- Description:N/A
GenerateServiceArea(PointShape,TimeSpan,Single,SpeedUnit,Double,GeographyUnit)
- 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
- 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.
- gridSize
- Type:Double
- Description:N/A
- gridSizeUnit
- Type:GeographyUnit
- Description:N/A
GenerateServiceArea(String,TimeSpan,Single,SpeedUnit)
- 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
- 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
- N/A
Return Value
- Type: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:SpeedUnit
- Description:N/A
- gridSize
- Type:Double
- Description:N/A
- gridSizeUnit
- Type:GeographyUnit
- Description:N/A
ToString()
- N/A
Remarks
- N/A
Return Value
- Type:String
- Description:N/A
Parameters
Equals(Object)
- N/A
Remarks
- N/A
Return Value
- Type:Boolean
- Description:N/A
Parameters
- obj
- Type:Object
- Description:N/A
GetHashCode()
- N/A
Remarks
- N/A
Return Value
- Type:Int32
- Description:N/A
Parameters
GetType()
- N/A
Remarks
- N/A
Return Value
- Type:Type
- Description:N/A
Parameters
GetAngleBetweenTwoLines(LineShape,LineShape)
- N/A
Remarks
- N/A
Return Value
- Type:Double
- Description:N/A
Parameters
- fromLine
- Type:LineShape
- Description:N/A
- toLine
- Type:LineShape
- Description:N/A
GetDrivingDirection(LineShape,LineShape)
- N/A
Remarks
- N/A
Return Value
- Type:DrivingDirection
- Description:N/A
Parameters
Protected Methods
GetRouteCore(String,String,IEnumerable<String>,Int32)
- N/A
Remarks
- N/A
Return Value
- Type: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
GetRouteCoreWithPoints(PointShape,PointShape,IEnumerable<PointShape>,Int32)
- N/A
Remarks
- N/A
Return Value
- Type:RoutingResult
- Description:N/A
Parameters
- startPoint
- Type:PointShape
- Description:N/A
- endPoint
- Type:PointShape
- Description:N/A
- stops
- Type:IEnumerable<PointShape>
- Description:N/A
- iterations
- Type:Int32
- Description:N/A
OnGettingRouteViaVisitStops(GettingRouteViaVisitStopsRoutingEngineEventArgs)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- e
- Description:N/A
OnGeneratingServiceArea(GeneratingServiceAreaRoutingEngineEventArgs)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
MemberwiseClone()
- N/A
Remarks
- N/A
Return Value
- Type:Object
- Description:N/A
Parameters
Public Properties
SearchRadiusInMeters
- N/A
Remarks
- N/A
Return Value
- Type:Double
RoutingAlgorithm
- N/A
Remarks
- N/A
Return Value
Remarks
- N/A
Return Value
Remarks
- N/A
Return Value
Remarks
- N/A
Return Value
Remarks
- N/A
Return Value
Remarks
- N/A
Return Value
Remarks
- N/A
Return Value
- Type:Double
Protected Properties
Public Events
GeneratingServiceArea
- N/A
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
- N/A
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