Estimated Time of Arrival Calculation

Characteristic

Use

ETA Calculation is not enabled by default. To activate it, the user have to send both a pathWaypoint and ETACalculationOptions.

Detailed Consideration

To update the time of arrival of a vehicle, The PTV xRoute service requires the current routeClosed 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. that the driver is following (contained in the pathWaypoint) and the current vehicle position (contained in the etaCalculationOptions).

Path Waypoint

PathWaypoint is a type of InputWaypoint that contain an EncodedPath. The encodedPath of a route can be requested with the encodedPath result field. It contains all route-related information previously calculated. It will be used to update arrival time according to the current vehicle position.

ETA Calculation Options

ETACalculationOptions is part of RouteOptions. It contains all data relevant to the calculation of the estimated time of arrival.
The VehiclePosition contains all vehicle-related information. There are two types of vehicle positions that describe the actual state of the vehicle: PositionEnRoute and PositionAtStop.

Position en route

The PositionEnRoute describes states where vehicles are driving. It contains 4 fields:

Position at stop

The PositionAtStop describes the state where the vehicle is located on a waypoint. In this VehiclePosition, the vehicle does not drive and is performing service time. This way, it is required to specify the status of the service at this waypoint. In order to do that, the user must send one of the three ServiceStatus:

Results

The vehicle position will be inserted as the first waypoint of the resulting route in the list of waypoints. Its name will be VEHICLE_POSITION. Even though it may be redundant for a position at a stop, but omitting it would result in a route with only one waypoint when being at the last waypoint. For consistency reasons there will also be a WAYPOINT_EVENT and a TOUR_EVENT in the list of route events, if requested. The service time will always be 0.