open_simulation_interface  v3.4.0 (2021-11-18)
osi3::TrafficUpdate Struct Reference

The traffic update message is provided by traffic participant models to provide updates to their position, state and future trajectory back to the simulation environment. The message is designed to update data of exactly one traffic participant, optionally with an attached trailer. More...

Collaboration diagram for osi3::TrafficUpdate:

Public Attributes

optional InterfaceVersion version = 1
 
optional Timestamp timestamp = 2
 
repeated MovingObject update = 3
 

Detailed Description

The traffic update message is provided by traffic participant models to provide updates to their position, state and future trajectory back to the simulation environment. The message is designed to update data of exactly one traffic participant, optionally with an attached trailer.

Note
For reasons of convenience and consistency, the updated information is provided as a MovingObject. Certain fields of this sub-message are not required to be set and will be ignored by the simulation environment, because they are static information. Instead of creating a seperate message type for only the non-static information, re-use existing message.

Member Data Documentation

◆ timestamp

optional Timestamp osi3::TrafficUpdate::timestamp = 2

The data timestamp of the simulation environment. Zero time is arbitrary but must be identical for all messages. Zero time does not need to coincide with the UNIX epoch. Recommended is the starting time point of the simulation.

Note
For moving object update data the timestamp coincides both with the notional simulation time the data applies to and the time it was sent. There is no inherent latency for moving object update data, as opposed to sensor data.

◆ update

repeated MovingObject osi3::TrafficUpdate::update = 3

Updated traffic participant data

Note
It is not expected that static fields are populated. If they are, they may be ignored by the receiver of this message, for example, dimensions, or vehicle category. All dynamic fields should be populated where known, for example, velocity, light states, or future trajectory.
The field is repeated because it is possible to have a trailer attached to a vehicle, see MovingObject::VehicleClassification::has_trailer and MovingObject::VehicleClassification::trailer_id.

◆ version

optional InterfaceVersion osi3::TrafficUpdate::version = 1

The interface version used by the sender (traffic participant model).


The documentation for this struct was generated from the following file: