RouteMatrix Class |  |
Learn more about Verizon Connect GeoBase.
Get information about the latest release
RouteMatrix maintains a cost matrix calculated from a set of RouteStops.
Due to enconomies-of-scale benefits, a RouteMatrix provides a quick and efficient means of calculating
times and distances between a number of RouteStops.
Inheritance HierarchyNamespace: Telogis.GeoBase.Routing
Assembly: geobase.net (in geobase.net.dll) Version: 4.99.0.0
SyntaxThe RouteMatrix type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RouteMatrix(RouteStop, RoutingStrategy) |
Create a new Matrix from the given set of RouteStops.
|
| RouteMatrix(RoutingStrategy, String) |
Load the RouteMatrix from the given journal file.
|
| RouteMatrix(RouteStop, RoutingStrategy, String) |
Create a new Matrix from the given set of RouteStops, and record the
actions taken during calculation of this RouteMatrix to the given journal file. The journal file can then be
loaded later to speed up the construction of an identical RouteMatrix.
|
| RouteMatrix(RouteStop, RoutingStrategy, CancellationToken) |
Create a new Matrix from the given set of RouteStops.
|
| RouteMatrix(RoutingStrategy, String, CancellationToken) |
Load the RouteMatrix from the given journal file.
|
| RouteMatrix(RouteStop, RoutingStrategy, String, CancellationToken) |
Create a new Matrix from the given set of RouteStops, and record the
actions taken during calculation of this RouteMatrix to the given journal file. The journal file can then be
loaded later to speed up the construction of an identical RouteMatrix.
|
Properties| Name | Description | |
|---|---|---|
 | CurrentTime |
Sets the start time for the routes from each of the stops in the matrix.
This will be used to guide time-specific routing features such as traffic
and constraints. The time is in UTC.
|
| LocationsToCalculate |
Returns an array of LatLon objects, which contains the locations
to calculate as part of this route matrix. This property allows you to define a subset of
locations to calculate the route matrix from, to speed up calculations. If this property is
null, all rows and columns of the route matrix are calculated.
|
| ObeyConstraints |
Setting this true ensures that constraints are obeyed when calculating routes.
|
| Stops |
Returns an array of stops in the order of the matrix.
|
| Strategy |
Sets the routing strategy. When the routing strategy is changed
the existing network is recalculated rather than rebuilt. Changing the
strategy on an existing RouteMatrix object is much faster than creating
a new RouteMatrix object.
|
| VehicleSpec |
Applies a VehicleSpec to this RouteMatrix. When this value is changed the existing
network is recalculated rather than rebuilt, and constraints are enabled
automatically.
|
Methods| Name | Description | |
|---|---|---|
| AddStop |
Add a new RouteStop to the matrix.
|
| AddStops |
Add new RouteStops to the matrix.
|
| Dispose | Releases all resources used by the RouteMatrix |
| Distances(Int32) |
Returns an array of distances (in meters) from the specified stop to all other stops.
|
| Distances(Int32, Int32, LinkCost) |
Returns an array of distances (in meters) from the specified stop to all other stops.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| RecalculateFull |
Clear the cached results from the matrix's times/distances/costs calculations.
|
| Times(Int32) |
Returns an array of times (in seconds) from the specified stop to all others.
|
| Times(Int32, Int32, LinkCost) |
Returns an array of times (in seconds) from the specified stop to all
others, the maximum number of stops and the route cost.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
RemarksRelated articles: Using a RouteMatrix.
No two methods should be executed at the same time, with the exception of AbortComputation.
See Also