Route Methods |  |
Learn more about Verizon Connect GeoBase.
Get information about the latest release
The Route type exposes the following members.
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 | |
| Calculate(CancellationToken) | |
| Calculate(UnitSystem) | |
| Calculate(UnitSystem, CancellationToken) | |
| Calculate(UnitSystem, IAsyncDirectionsHandler) | |
| Calculate(UnitSystem, IAsyncDirectionsHandler, 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 | |
| ClearStops | |
| 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 | |
 | 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 | |
| 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 | |
| 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.
|
See Also