Thenamespace provides types to create, query and optimize routes.
Optimization of routes is controlled with the RoutingStrategy. GeoBase provides RoutingStrategyFastest (which calculates the fastest route between route stops), RoutingStrategyShortest (which calculates the shortest route between route stops), and RoutingStrategyForPedestrian (which calculates the optimal route for a pedestrian). The routing strategy can be customized using the RouteCustomCostFunc delegate.
There are also a number of routing tutorials in the GeoBase | Routing Tutorial section of this help guide.
A movement that occurs on arrival at the destination.
Provides information associated with an AsyncDirectionsEvent.
A class used to describe the constraints along links.
CustomRoutingInfo is provided to a RouteCustomCostFunc to aid in adjusting the cost of traveling on a particular link. It contains information about the link to be evaluated.
A driving route through a number of stops.
A class to describe a distance and its associated unit system.
A movement that occurs when embarking/disembarking a ferry.
Freeway to freeway ramp movement - occurs when moving from one freeway to another.
A Note informing that the freeway ends.
Freeway to surface ramp movement
A driving direction that instructs the driver to turn at an intersection.
A class used to provide information about a movement.
Used to display an arrow on a map indicating the flow of the movement.
A tagged object that can be added by the client application. Movement tags can be added to any Movement along the route.
Provides functionality similar to RouteMatrix, but with the added benefit of being able to specify the number of threads to be used; ideal for multi-core systems working with large matrices. When the matrix is instantiated, the whole matrix is calculated in one go. Using persist provides the option to save the results to disk for faster, subsequent, data retrieval.
A Note informing that the link name has changed.
Thrown when no optimal solution can be found by OptimizeStops.
An incidental note that doesn't affect the route but provides information to assist the driver in navigating the route (such as street name changes).
This exception is thrown when an intersection can't be found in the route's heap.
Describes an optimized route stop.
A class used to determine if the time windows on a route can be achieved.
A movement for a traffic circle.
Thrown when a Route or RouteMatrix object attempts to make an invalid combination of calls simultaneously, in order to prevent unspecified behavior.
Represents a set of flags for a StreetLink. These flags include access restrictions, the legal speed limit, and the link type.
A class used to provide data about a route highlight, which displays the most likely route that was taken, based on a series of RouteStops.
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.
Thrown when a route cannot be found between given locations
Used to determine the speed profile (based on functional class and speed category) when routing. See remarks.
A collection of routing settings that can be used to control routing priorities. Can be set per route or per link.
Surface to freeway ramp movement.
Represents a table of speed limits associated with a given GBFS file. This is a mapping from SpeedCat (speed category) to Speed.
A movement describing how to maneuver a split road.
A Note informing that the state line is being crossed.
Represents the various names that a street can have.
A Note informing that the tollway begins.
A Note informing that the tollway ends.
A movement describing how to maneuver at a turn.
A Note informing that a waypoint is ahead.
Describes a single constraint condition belonging to a ConstraintLinks object.
A structure representing the cost of traversing a link or a set of links in a route.
Summarizes the type and weight of one load element
Used to describe a vehicle's specifications.
Handles updates to the Directions object.
Provides a common interface that all Route implementations implement.
A predicate that instructs the routing engine whether or not a key access constraint should be ignored.
A function that can evaluate information about a link and return an additional cost for travel on that link.
Returns calculation progress as a percentage during a route operation.
Used to describe the type of a ConstrainedVehicle
Used to describe the blockType, which defines the type of constraint that is on a link. If there is a MultiLink constraint, then the constraint applies for the path that traverses all of the links referenced in the MultiLink constraint block. The ConstraintBlockType determines the interpretation of the blockValue.
Describes the direction of travel along a street link. Each street link has a reference end and a non-reference end.
An enumeration of points on a compass
Describes a load carried by a vehicle. Hazardous loads should be categorized using a HAZMAT category (such as Hazmat_1).
Describes the type of movement that a direction encompasses.
Used to define the type of a Note.
The permitted type of road crossing behavior.
A direction of movement through a traffic circle.
The cost units used for a given route strategy.
Describes the type of street index available.
Describes the time window violation of a given stop on an optimized route.
Describes the source of speed limit data for this link.
Describes a type of vehicle