IRoute Interface

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.99.0.0

Syntax

public interface IRoute : IMapRenderer, IMapMouseHandler, 
	IDisposable

Public Interface IRoute
	Inherits IMapRenderer, IMapMouseHandler, IDisposable

The IRoute type exposes the following members.

Properties

	Name	Description
	Calculated	Indicates if the route has been calculated.
	CurrentTime	Gets or sets the current time, as used by the route. The time is in UTC.
	End	Gets or sets the end stop of the route.
	MapMouseEventsHandler	Gets the MapMouseEventsHandler. (Inherited from IMapMouseHandler.)
	PersistNetwork	Gets or sets a flag that signals whether to keep the routing network in memory after the route has been calculated.
	RequiredRendermodes	Specifies at which stages of rendering this renderer should be called. (Inherited from IMapRenderer.)
	Start	Gets or sets the start point of the route.
	StopCount	Gets the number of stops on the route.
	Strategy	Gets or sets the RoutingStrategy used to calculate the route costs.
	VehicleSpec	Gets or sets the VehicleType for the route.

Top

Methods

	Name	Description
	AddStop(RouteStop)	Adds a single stop to the route.
	AddStop(RouteStop, Int32)	Adds a single stop to a specified position in the route.
	AddStops	Adds a number of stops to the route.
	Calculate	Calculates the route, from Start to End.
	Calculate(CancellationToken)	Calculates the route, from Start to End allowing cancellation using a CancellationToken.
	Calculate(UnitSystem)	Calculates the route using the specified units.
	Calculate(UnitSystem, CancellationToken)	Calculates the route, from Start to End allowing cancellation using a CancellationToken.
	Calculate(UnitSystem, IAsyncDirectionsHandler)	Calculates the cost of the route using the specified units.
	Calculate(UnitSystem, IAsyncDirectionsHandler, CancellationToken)	Calculates the route, from Start to End allowing cancellation using a CancellationToken.
	CalculateCostMatrix	Creates a cost matrix representing all stops in the route.
	CalculateCostMatrix(CancellationToken)	Calculates a cost matrix representing all stops in the route allowing cancellation using a CancellationToken.
	Clear	Clear all RouteStops and Breaks from the route, including Start and End.
	ClearStops	Clear all RouteStops and Breaks with specific locations from the route.
	CreateConstraint	Generate a new constraint for this route.
	DeleteStop	Delete a specified RouteStop from the route.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
	ForceRecalculate	Forces the optimal route to be recalculated.
	GetDirections	Gets the Directions for the route using the units in Units.
	GetDirections(CancellationToken)	Gets the Directions for the route allowing cancellation using a CancellationToken.
	GetDirections(String)	Gets the Directions for the route using the specified culture.
	GetDirections(UnitSystem)	Gets the Directions for the route using the specified units.
	GetDirections(String, CancellationToken)	Gets the Directions for the route using the specified culture allowing cancellation using a CancellationToken.
	GetDirections(UnitSystem, String)	Gets the Directions for the route using the specified culture and units.
	GetDirections(UnitSystem, CancellationToken)	Gets the Directions for the route using the specified units allowing cancellation using a CancellationToken.
	GetDirections(UnitSystem, String, CancellationToken)	Gets the Directions for the route using the specified culture and units allowing cancellation using a CancellationToken.
	GetDirections(UnitSystem, String, IAsyncDirectionsHandler)	Gets the Directions for the route using the specified units. Directions events are sent to 'handler' as directions are built.
	GetDirections(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.
	GetPath	Gets the Directions for the route without any textual instructions.
	GetPath(CancellationToken)	Gets the Directions for the route without any textual instructions.
	GetQuickDirections	Gets the (Quick) Directions for the route.
	GetQuickDirections(CancellationToken)	Requests the cancellation of a GetQuickDirections method calculation using a CancellationToken.
	GetRouteHighlight	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.
	GetRouteHighlight(CancellationToken)	Requests the cancellation of a GetRouteHighlight method calculation using a CancellationToken.
	GetRouteHighlight(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.
	GetRouteHighlight(String, CancellationToken)	Requests the cancellation of a GetRouteHighlight(String) method calculation using a CancellationToken.
	GetStop	Gets a specified RouteStop on the route.
	GetTimeAndDistance(DistanceUnit, Double, TimeSpan)	Gets the total time and distance for the route.
	GetTimeAndDistance(DistanceUnit, Double, TimeSpan, CancellationToken)	Requests the cancellation of a GetTimeAndDistance(DistanceUnit, Double, TimeSpan) method calculation using a CancellationToken.
	GetTimeAndDistance(DistanceUnit, Double, TimeSpan, LinkCost)	Gets the total time and distance for the route.
	GetTimeAndDistance(DistanceUnit, Double, TimeSpan, LinkCost, CancellationToken)	Requests the cancellation of a GetTimeAndDistance(DistanceUnit, Double, TimeSpan, LinkCost) method calculation using a CancellationToken.
	HitTest	Test if the given x,y coordinates lie within the bounds of this item. (Inherited from IMapMouseHandler.)
	OptimizeStops	Optimizes the stop ordering on the route.
	OptimizeStops(DateTime)	Optimizes the stop ordering on the route in consideration of the traffic and the time windows of the stops.
	Render	Called when this item should render itself on the map. (Inherited from IMapRenderer.)

Top

Remarks

Reference

Telogis.GeoBase.Routing Namespace