Skip to content

Commit 1ea5eed

Browse files
author
Habedank Clemens
committed
refactoring and clarifying semantics
Signed-off-by: Habedank Clemens <qxs2704@europe.bmw.corp>
1 parent 446151c commit 1ea5eed

File tree

2 files changed

+35
-22
lines changed

2 files changed

+35
-22
lines changed

osi_trafficcommand.proto

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,18 @@ message TrafficCommand
5959
// regarding that are not part of this message, yet are seen as a task of the
6060
// scenario description, for example, OpenSCENARIO.
6161
//
62-
// \note All traffic actions are sent only once just before they are about
62+
// \attention All traffic actions are sent only once just before they are about
6363
// to start. This is also true, if their execution is expected to
6464
// take simulation time. To inform the traffic participant
6565
// model that certain actions must or shall be terminated, there are
6666
// explicit actions nested inside this message (AbortActionsAction,
6767
// EndActionsAction), which hold a reference to the respective actions.
68+
// It is highly recommended for the scenario engine to handle the state
69+
// machine of traffic actions and to use AbortActionsActions /
70+
// EndActionsAction to transfer information to the traffic participant.
71+
// Furthermore, the scenario engine shall listen to DismissedActions of
72+
// \c TrafficCommandUpdate to reflect this in the evaluation of the
73+
// scenario run.
6874
//
6975
message TrafficAction
7076
{

osi_trafficcommandupdate.proto

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ package osi3;
99

1010
//
1111
// \brief This message enables the traffic participant model to send updates
12-
// to the scenario engine about the execution of its received \c TrafficCommand input. While traffic
13-
// actions are usually executed successfully by the traffic participant
12+
// to the scenario engine about the execution of its received \c TrafficCommand input.
13+
// While traffic actions are usually executed successfully by the traffic participant
1414
// there may be actions which the traffic participant is not able to execute
1515
// either for capability or situation-specific reasons. This message gives
1616
// the traffic participant the basic possiblity to send feedback if an action
1717
// cannot happen as requested by the \c TrafficCommand. Currently, it is out of
1818
// scope to standardize the exact reason for non-executability or failed execution
1919
// because the reason can have multiple explantions. The point in time
20-
// for this message to be sent is only restricted to be after the \c TrafficCommand
21-
// with the corresponding traffic action(s) has been sent. The
20+
// for this message to be sent is only restricted to be after (or at the same time)
21+
// the \c TrafficCommand with the corresponding traffic action(s) has been sent. The
2222
// responsibility for deciding about successful or unsuccessful scenario execution
2323
// lies fully on the side of the scenario engine.
2424
//
@@ -44,24 +44,31 @@ message TrafficCommandUpdate
4444
//
4545
optional Identifier traffic_participant_id = 3;
4646

47-
// Dismissed traffic action id(s) from the perspective of a traffic participant, if any.
47+
// Actions which a traffic participant dismisses.
4848
//
49-
// \note Dismissed traffic action id(s) identify actions which cannot be executed or
50-
// completed by the traffic participant. If more than one action id is supplied it means that
51-
// multiple actions are regarded as dismissed. This field must have the same value(s) as
52-
// \c TrafficAction::ActionHeader::action_id of the prior sent \c TrafficCommand and must correspond
53-
// to the same traffic participant.
49+
// \note If more than one action id is supplied it means that
50+
// multiple actions are regarded as dismissed.
5451
//
55-
// \Attention If an action is not dismissed, abortet by the scenario engine with a
56-
// \c TrafficAction::AbortActionsAction or ended by the scenario engine with a
57-
// \c TrafficAction::EndActionsAction it is assumed that the traffic participant is
58-
// in the process of executing this action.
59-
//
60-
repeated Identifier dismissed_action_id = 4;
61-
62-
// Information about the reason of failure.
52+
repeated DismissedAction dismissed_action;
53+
6354
//
64-
// \note This is just a custom, informal string without a standardized meaning.
55+
// \brief Action which a traffic participant dismisses.
6556
//
66-
optional string failure_reason = 5;
67-
}
57+
message DismissedAction
58+
{
59+
// Dismissed traffic action id from the perspective of a traffic participant, if any.
60+
//
61+
// \note A dismissed traffic action id identifies a \c TrafficAction which cannot be executed or
62+
// completed by the traffic participant. This field must have the same value as
63+
// \c TrafficAction::ActionHeader::action_id of a prior sent \c TrafficCommand and must correspond
64+
// to the same traffic participant.
65+
//
66+
optional Identifier dismissed_action_id = 4;
67+
68+
// Information about the reason of failure.
69+
//
70+
// \note This is just a custom, informal string without a standardized meaning.
71+
//
72+
optional string failure_reason = 5;
73+
}
74+
}

0 commit comments

Comments
 (0)