Route Class

Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release

A Route consists of a series of RouteStops. The Route can generate point to point directions and optimize multi-stop routes.

Inheritance Hierarchy

SystemObject
Telogis.GeoBase.RoutingRoute
Telogis.GeoBase.Internal.Routing.NWFNWFRoute

Namespace: Telogis.GeoBase.Routing
Assembly: geobase.net (in geobase.net.dll) Version: 4.99.0.0

Syntax

Copy

[SerializableAttribute]
public class Route : IRoute, IMapRenderer, 
	IMapMouseHandler, IDisposable

<SerializableAttribute>
Public Class Route
	Implements IRoute, IMapRenderer, IMapMouseHandler, IDisposable

The Route type exposes the following members.

Constructors

	Name	Description
	Route	Create a new, empty, Route without any RouteStops.
	Route(RouteStop, RouteStop)	Create a new route with given start and end points.

Top

Properties

	Name	Description
	BondedLinks	Sets the bonded links. Routes calculated with this property set will not deviate from the provided list of links.
	Calculated	Check if this route needs to be calculated.
	CurrentTime	Get or set the current time, as a DateTime. The time is in UTC.
	CustomRoutingAccessKeys	Obsolete. Gets or sets the custom routing access keys for this route. For internal use only.
	End	The end location of this route.
	MapMouseEventsHandler	Gets the events object for the list - Always null.
	PersistNetwork	Gets or sets a flag that signals whether to keep the routing network in memory after the route has been calculated. This uses more memory but speeds recalculation of the route when using multiple routing strategies.
	RequiredRendermodes	Gets the RenderMode required by this Route.
	RouteProgress	Gets or sets the RouteProgress delegate used to calculate the progress made as the user travels along the route.
	Start	Get or set the starting location of route.
	StopCount	Return the number of RouteStops on the route.
	Strategy	Sets the RoutingStrategy used to optimize stops and calculate directions. Default is RoutingStrategyFastest.
	VehicleSpec	The specifications of the vehicle to drive the route.

Top

Methods

	Name	Description
	AddStop(RouteStop)	Adds a RouteStop at the most logical place in the list. Multiple stops at the same location are ignored.
	AddStop(RouteStop, Int32)	Adds a RouteStop at the specified location in the list.
	AddStopAtEnd	Adds a RouteStop at the end of the list of stops.
	AddStops	Adds all the supplied RouteStop objects to the route at the most logical places in the list.
	Calculate	Calculates the route, from Start to End through intervening RouteStops.
	Calculate(CancellationToken)	Calculates the route, from Start to End allowing cancellation using a CancellationToken.
	Calculate(UnitSystem)	Calculates the route, from Start to End through intervening RouteStops.
	Calculate(UnitSystem, CancellationToken)	Calculates the route, from Start to End allowing cancellation using a CancellationToken.
	Calculate(UnitSystem, IAsyncDirectionsHandler)	Calculates the route, from Start to End through intervening RouteStops.
	Calculate(UnitSystem, IAsyncDirectionsHandler, CancellationToken)	Calculates the route, from Start to End allowing cancellation using a CancellationToken.
	CalculateCostMatrix	Calculates a matrix of costs to travel from and to each stop in the route.
	CalculateCostMatrix(CancellationToken)	a matrix of costs to travel from and to each stop in the route allowing cancellation using a CancellationToken. Requests the cancellation of a CalculateCostMatrix method calculation using a CancellationToken.
	Clear	Clear all RouteStops and Breaks, including Start and End.
	ClearStops	Clear all RouteStops and Breaks with specific locations on the route - but not the start and end stops.
	CreateConstraint	Generate a new constraint for this route.
	DeleteStop	Removes the given RouteStop from the route. Note that if an OptimizeStops() operation has been performed on the Route, the original RouteStops may have been replaced.
	Deserialize	Deserialize a Route after it has previously been serialized using the Serialize method.
	Dispose	Dispose of this route object.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ForceRecalculate	Force the route to be recalculated. This should be called if anything the route is unaware of changes.
	FromXml	Clear any existing RouteStops from our route and load a new set of RouteStops from XML (passed to this method as a XmlNode.
	GetConstraints(LatLon)	Return a list of ConstraintLinks for the given link location.
	GetConstraints(LatLon, Boolean)	Return a list of ConstraintLinks for the given link location.
	GetDirections	Calculate the route and return a representative Directions object. The UnitSystem for the directions is taken from Units.
	GetDirections(CancellationToken)	Requests the cancellation of a GetDirections method calculation using a CancellationToken.
	GetDirections(String)	Calculate the route and return a representative Directions object using the given culture.
	GetDirections(UnitSystem)	Calculate the route and return a representative Directions object using the specified UnitSystem.
	GetDirections(String, CancellationToken)	Requests the cancellation of a GetDirections(String) method calculation using a CancellationToken.
	GetDirections(UnitSystem, String)	Calculate the route and return a representative Directions object using the specified UnitSystem and culture.
	GetDirections(UnitSystem, CancellationToken)	Requests the cancellation of a GetDirections(UnitSystem) method calculation using a CancellationToken.
	GetDirections(UnitSystem, String, CancellationToken)	Requests the cancellation of a GetDirections(UnitSystem, String) method calculation using a CancellationToken.
	GetDirections(UnitSystem, String, IAsyncDirectionsHandler)	Calculate the route and return a representative Directions object using the specified UnitSystem and culture.
	GetDirections(UnitSystem, String, IAsyncDirectionsHandler, CancellationToken)	Gets the Directions for the route using the specified units. Directions events are sent to 'handler' as directions are built. Calculation of the directions can be cancelled using the CancellationToken parameter.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetPath	Gets the Directions for the route without any textual instructions.
	GetPath(CancellationToken)	Gets the Directions for the route without any textual instructions.
	GetQuickDirections	Calculate the route and return a Directions object, without generating natural language directions or checking for route legality.
	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 the RouteStop at index.
	GetTimeAndDistance(DistanceUnit, Double, TimeSpan)	Calculate the time and distance for this 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)	Calculate the time and distance for this route.
	GetTimeAndDistance(DistanceUnit, Double, TimeSpan, LinkCost, CancellationToken)	Requests the cancellation of a GetTimeAndDistance(DistanceUnit, Double, TimeSpan, LinkCost) method calculation using a CancellationToken.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetVehicleSpeedLimit(StreetLink, SpeedUnit)	Obsolete. Gets the speed limit on a link for a vehicle whose specifications are in the VehicleSpec of this Route. Only supported in local mode.
	GetVehicleSpeedLimit(LatLon, UInt64, SpeedUnit)	Gets the speed limit on a link for a vehicle whose specifications are in the VehicleSpec of this Route. Only supported in local mode.
	HitTest	Check if there is a hit on any of the RouteStops in this route.
	LoadRouteHighlightFromCsv	Loads a route from a csv given the filename (and path) of that csv. The csv requires these Headers: Lat, Lon, Speed, Heading, TimeSincePreviousStop
	OptimizeStops	Reorders the RouteStop for an optimal route, according to the current Strategy.
	OptimizeStops(DateTime)	Reorder the route stops for an optimal route, according to the current Strategy.
	Render	Renders the route on the given IMap.
	Serialize	Serialize the Route to the supplied stream. The serialized Route can be deserialized using the Deserialize method.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ToXmlString	Convert this route to XML. The XML is added to the passed in XmlNode.

Top

Fields

	Name	Description
	MemoryLimit	The memory limit for a directions calculation for all routes, in megabytes. Defaults to 0, which indicates no memory limit.

Top

Remarks

Reference

Telogis.GeoBase.Routing Namespace