Click or drag to resize

IRoute Interface

Verizon Connect Logo
Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release
Provides a common interface that all Route implementations implement.

Namespace:  Telogis.GeoBase.Routing
Assembly:  geobase.net (in geobase.net.dll) Version: 4.83.0.0
Syntax
public interface IRoute : IMapRenderer, IMapMouseHandler, 
	IDisposable

The IRoute type exposes the following members.

Properties
  NameDescription
Public propertyCalculated
Indicates if the route has been calculated.
Public propertyCurrentTime
Gets or sets the current time, as used by the route. The time is in UTC.
Public propertyEnd
Gets or sets the end stop of the route.
Public propertyMapMouseEventsHandler
Gets the MapMouseEventsHandler.
(Inherited from IMapMouseHandler.)
Public propertyPersistNetwork
Gets or sets a flag that signals whether to keep the routing network in memory after the route has been calculated.
Public propertyCode exampleRequiredRendermodes
Specifies at which stages of rendering this renderer should be called.
(Inherited from IMapRenderer.)
Public propertyStart
Gets or sets the start point of the route.
Public propertyStopCount
Gets the number of stops on the route.
Public propertyStrategy
Gets or sets the RoutingStrategy used to calculate the route costs.
Public propertyVehicleSpec
Gets or sets the VehicleType for the route.
Top
Methods
  NameDescription
Public methodAddStop(RouteStop)
Adds a single stop to the route.
Public methodAddStop(RouteStop, Int32)
Adds a single stop to a specified position in the route.
Public methodAddStops
Adds a number of stops to the route.
Public methodCalculate
Calculates the route, from Start to End.
Public methodCalculate(CancellationToken)
Calculates the route, from Start to End allowing cancellation using a CancellationToken.
Public methodCalculate(UnitSystem)
Calculates the route using the specified units.
Public methodCalculate(UnitSystem, CancellationToken)
Calculates the route, from Start to End allowing cancellation using a CancellationToken.
Public methodCalculate(UnitSystem, IAsyncDirectionsHandler)
Calculates the cost of the route using the specified units.
Public methodCalculate(UnitSystem, IAsyncDirectionsHandler, CancellationToken)
Calculates the route, from Start to End allowing cancellation using a CancellationToken.
Public methodCalculateCostMatrix
Creates a cost matrix representing all stops in the route.
Public methodCalculateCostMatrix(CancellationToken)
Calculates a cost matrix representing all stops in the route allowing cancellation using a CancellationToken.
Public methodClear
Clear all RouteStops and Breaks from the route, including Start and End.
Public methodClearStops
Clear all RouteStops and Breaks with specific locations from the route.
Public methodCreateConstraint
Generate a new constraint for this route.
Public methodDeleteStop
Delete a specified RouteStop from the route.
Public methodDispose (Inherited from IDisposable.)
Public methodForceRecalculate
Forces the optimal route to be recalculated.
Public methodGetDirections
Gets the Directions for the route using the units in Units.
Public methodGetDirections(String)
Gets the Directions for the route using the specified culture.
Public methodGetDirections(CancellationToken)
Gets the Directions for the route allowing cancellation using a CancellationToken.
Public methodGetDirections(UnitSystem)
Gets the Directions for the route using the specified units.
Public methodGetDirections(String, CancellationToken)
Gets the Directions for the route using the specified culture allowing cancellation using a CancellationToken.
Public methodGetDirections(UnitSystem, String)
Gets the Directions for the route using the specified culture and units.
Public methodGetDirections(UnitSystem, CancellationToken)
Gets the Directions for the route using the specified units allowing cancellation using a CancellationToken.
Public methodGetDirections(UnitSystem, String, CancellationToken)
Gets the Directions for the route using the specified culture and units allowing cancellation using a CancellationToken.
Public methodGetDirections(UnitSystem, String, IAsyncDirectionsHandler)
Gets the Directions for the route using the specified units. Directions events are sent to 'handler' as directions are built.
Public methodGetDirections(UnitSystem, String, IAsyncDirectionsHandler, CancellationToken)
Gets the Directions for the route using the specified culture and units allowing cancellation using a CancellationToken. Directions events are sent to 'handler' as directions are built.
Public methodGetPath
Gets the Directions for the route without any textual instructions.
Public methodGetPath(CancellationToken)
Gets the Directions for the route without any textual instructions.
Public methodGetQuickDirections
Gets the (Quick) Directions for the route.
Public methodGetQuickDirections(CancellationToken)
Public methodCode exampleGetRouteHighlight
Get the likely route that was taken between the points in a given route history, without generating natural language directions or checking for route legality.
Public methodCode exampleGetRouteHighlight(String)
Reads point data from a file, and gets the likely route that was taken between the points in the route, without generating natural language directions or checking for route legality.
Public methodGetRouteHighlight(CancellationToken)
Public methodGetRouteHighlight(String, CancellationToken)
Requests the cancellation of a GetRouteHighlight(String) method calculation using a CancellationToken.
Public methodGetStop
Gets a specified RouteStop on the route.
Public methodGetTimeAndDistance(DistanceUnit, Double, TimeSpan)
Gets the total time and distance for the route.
Public methodGetTimeAndDistance(DistanceUnit, Double, TimeSpan, CancellationToken)
Public methodGetTimeAndDistance(DistanceUnit, Double, TimeSpan, LinkCost)
Gets the total time and distance for the route.
Public methodGetTimeAndDistance(DistanceUnit, Double, TimeSpan, LinkCost, CancellationToken)
Public methodCode exampleHitTest
Test if the given x,y coordinates lie within the bounds of this item.
(Inherited from IMapMouseHandler.)
Public methodOptimizeStops
Optimizes the stop ordering on the route.
Public methodOptimizeStops(DateTime)
Optimizes the stop ordering on the route in consideration of the traffic and the time windows of the stops.
Public methodCode exampleRender
Called when this item should render itself on the map.
(Inherited from IMapRenderer.)
Top
Remarks
See Also