Characteristic
Short description
A single route
A route corresponds to a path of a vehicle through the underlying transport network. The main attributes of a route are the distance and the time that the vehicle travels along the path. event contains information which might be interesting for the driver or characterizes the course of the route such as reaching a waypoint A waypoint is a geographic location used to specify start, destination and possible stopovers for a route., entering a different country or subdivision, or executing a certain maneuver. The list of route events in RouteResponse.events is ordered chronologically along the route.
Use
The list of RouteEventTypes to be returned can be selected using ResultFields.eventTypes.
Detailed Consideration
Each route event in the chronologically ordered list contains some basic and some type-specific information. Use the basic information such as type and coordinate for marking the event in a map. If the node list is requested, each event also contains the index of the node at which the event occurs. This node index is equal to the corresponding segment index as every segment starts at the node with the same index. This rule does not apply to the very last node as there is no segment starting at this node.
If the node and/or segment list is requested, every node/segment also contains the indices of all route events occuring at the respective object. This way it is possible to both assign nodes and segments to events and vice-versa.
Good to know
Reference times
By default, the route calculation has no reference time. Therefore, the xRoute service cannot provide a reference time for the route event unless explicitly specified in some TimeConsideration scenario.
In order to obtain a reference time for each route event in that case, either use the RouteEvent.travelTimeFromStart to calculate the reference time, or use ExactTimeConsiderationAtStart. In that case, note that time-dependent data will be used, but it is possible not to specify any Feature Layers. It is not possible to set a reference time without using time-dependent data.
Local time
All date/time values in the route response will be returned using the same offset to UTC as the reference time given in the request. That means that the reference time of a route event is not necessarily given in local time. In order to calculate local time, use the UTCOffsetEvent to obtain the offset to UTC valid at the location of the route event.
Sorting order
The events are reported in chronological order. When several events occur at the same time, the sort order is by RouteEventType as follows:
- WAYPOINT_EVENT
- UTC_OFFSET_EVENT
- COUNTRY_EVENT
- TOUR_EVENT
- MANEUVER_EVENT
- TRAFFIC_EVENT
- ROUTE_VIOLATION_EVENT
- TOLL_EVENT
- COMBINED_TRANSPORT_EVENT
- LOW_EMISSION_ZONE_EVENT
- DELIVERY_ONLY_EVENT
There are several exceptions to take into account:
- The last event in the event list will always be the WAYPOINT_EVENT of the destination waypoint.
- If a TOUR_EVENT contains a non-zero duration, it will be placed after the others.
- For all RouteEventTypes with AccessType (COMBINED_TRANSPORT_EVENT, TOLL_EVENT, ROUTE_VIOLATION_EVENT, LOW_EMISSION_ZONE_EVENT, DELIVERY_ONLY_EVENT), an additional rule is applied. If these types of events occur simultaneously with another event, we sort the events as follows:
- If the event has an AccessType ENTER, it will be sorted last,
- If the event has an AccessType EXIT, it will be sorted first.
Related Topics
| Showcase | Consider Route Events |
| Technical concept | Time Consideration |