osi3::TrafficCommandUpdate Struct Reference

This message enables the traffic participant model to send updates to the scenario engine about the execution of its received TrafficCommand input. More...

Collaboration diagram for osi3::TrafficCommandUpdate:

Classes

struct  DismissedAction
 Action which a traffic participant dismisses. More...
 

Public Attributes

optional InterfaceVersion version = 1
 The interface version used by the sender (traffic participant model). More...
 
optional Timestamp timestamp = 2
 The data timestamp of the simulation environment. More...
 
optional Identifier traffic_participant_id = 3
 The ID of this traffic participant which must coincide with a prior sent ID, cf. More...
 
repeated DismissedAction dismissed_action = 4
 Actions which a traffic participant dismisses and which are not yet ended or aborted by the scenario engine (via a TrafficCommand::action.end_actions_action or a TrafficCommand::action.abort_actions_action). More...
 

Detailed Description

This message enables the traffic participant model to send updates to the scenario engine about the execution of its received TrafficCommand input.

While traffic actions are usually executed successfully by the traffic participant, there may be actions which the traffic participant is not able to execute either for capability or situation-specific reasons.

This message allows a traffic participant to send feedback if an action cannot happen as requested by the TrafficCommand. Currently, it is out of scope to standardize the exact reason for non-executability or failed execution because the reason can have multiple explanations. The responsibility for deciding about successful or unsuccessful scenario execution lies fully on the side of the scenario engine.

Note
This interface is currently just a placeholder and could be changed in experimental ways to support semantics of upcoming OpenSCENARIO versions.

Member Data Documentation

◆ version

optional InterfaceVersion osi3::TrafficCommandUpdate::version = 1

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

◆ timestamp

optional Timestamp osi3::TrafficCommandUpdate::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. It is recommended to use zero timestamp as the starting time point of the simulation.

◆ traffic_participant_id

optional Identifier osi3::TrafficCommandUpdate::traffic_participant_id = 3

The ID of this traffic participant which must coincide with a prior sent ID, cf.

TrafficCommand::traffic_participant_id.

◆ dismissed_action

repeated DismissedAction osi3::TrafficCommandUpdate::dismissed_action = 4

Actions which a traffic participant dismisses and which are not yet ended or aborted by the scenario engine (via a TrafficCommand::action.end_actions_action or a TrafficCommand::action.abort_actions_action).

Thus, the valid time interval for this action is after the TrafficCommand::timestamp for the respective action, which tells a traffic participant to perform an action, has been sent, but must not be after a TrafficCommand::timestamp of the respective End-Actions-Action or Abort-Actions-Action, which tells a traffic participant to end or abort that action.

Furthermore, a TrafficCommand::action.end_actions_action or a TrafficCommand::action.abort_actions_action must not be sent after this action (the TrafficCommandUpdate::dismissed_action) for a respective action has been sent.

Note
If more than one dismissed action is supplied it means that multiple actions are regarded as dismissed.

  • osi_trafficcommandupdate.proto