Click or drag to resize

RouteMatrix Class

Verizon Connect Logo
Print this page
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 Hierarchy
SystemObject
  Telogis.GeoBase.RoutingRouteMatrix

Namespace:  Telogis.GeoBase.Routing
Assembly:  geobase.net (in geobase.net.dll) Version: 4.83.0.0
Syntax
public class RouteMatrix : IRouteMatrix, 
	IDisposable

The RouteMatrix type exposes the following members.

Constructors
  NameDescription
Public methodRouteMatrix(RouteStop, RoutingStrategy)
Create a new Matrix from the given set of RouteStops.
Public methodRouteMatrix(RoutingStrategy, String)
Load the RouteMatrix from the given journal file.
Public methodRouteMatrix(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.
Public methodRouteMatrix(RouteStop, RoutingStrategy, CancellationToken)
Create a new Matrix from the given set of RouteStops.
Public methodRouteMatrix(RoutingStrategy, String, CancellationToken)
Load the RouteMatrix from the given journal file.
Public methodRouteMatrix(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.
Top
Properties
  NameDescription
Public propertyCurrentTime
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.
Public propertyLocationsToCalculate
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.
Public propertyObeyConstraints
Setting this true ensures that constraints are obeyed when calculating routes.
Public propertyStops
Returns an array of stops in the order of the matrix.
Public propertyStrategy
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.
Public propertyVehicleSpec
Applies a VehicleSpec to this RouteMatrix. When this value is changed the existing network is recalculated rather than rebuilt, and constraints are enabled automatically.
Top
Methods
  NameDescription
Public methodAddStop
Add a new RouteStop to the matrix.
Public methodAddStops
Add new RouteStops to the matrix.
Public methodDispose
Releases all resources used by the RouteMatrix
Public methodDistances(Int32)
Returns an array of distances (in meters) from the specified stop to all other stops.
Public methodDistances(Int32, Int32, LinkCost)
Returns an array of distances (in meters) from the specified stop to all other stops.
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodRecalculateFull
Clear the cached results from the matrix's times/distances/costs calculations.
Public methodTimes(Int32)
Returns an array of times (in seconds) from the specified stop to all others.
Public methodTimes(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.
Public methodToString (Inherited from Object.)
Top
Remarks

Related articles: Using a RouteMatrix.

No two methods should be executed at the same time, with the exception of AbortComputation.

See Also