Skip to content

Commit 16d99d2

Browse files
Habedank Clemenspmai
authored andcommitted
add some descriptions for LaneChangeAction
Signed-off-by: Pierre R. Mai <pmai@pmsf.de>
1 parent 399274f commit 16d99d2

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

osi_trafficcommand.proto

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@ message TrafficAction
8787
//
8888
// \note The StatePoint definition does not define mandatory fields.
8989
// The context defines how and what fields are used.
90-
// For example: Path only used xyz of the StatePoint, trajectory also timestamp...
90+
// For example: FollowPathAction does not use timestamp in contrast to
91+
// FollowTrajectoryAction.
9192
//
9293
message StatePoint
9394
{
@@ -254,7 +255,7 @@ message FollowPathAction
254255
//
255256
// \brief Acquire Global Position Action.
256257
//
257-
// This action assigns a route to an traffic participant. The route
258+
// This action assigns a route to a traffic participant. The route
258259
// assigned will be the shortest route (along roads or satisfying any
259260
// other constraints a traffic participant is operating under) between
260261
// the traffic participant's current position and the position specified.
@@ -291,6 +292,17 @@ message AcquireGlobalPositionAction
291292
//
292293
// \brief Lane Change Action.
293294
//
295+
// This action assigns a lane change to a traffic participant. The fields
296+
// of this message enable different levels of constraint for the traffic
297+
// participant depending on the use case. In case the constraints are
298+
// supposed to be small, the dynamics shape or even the duration and
299+
// the distance for the lane change can be omitted.
300+
//
301+
// \note This action is aligned with LaneChangeAction of OpenSCENARIO 1.0
302+
// defining the targeted lane and optionally the parametrization of the
303+
// lane change.
304+
//
305+
294306
message LaneChangeAction
295307
{
296308
// The Action Header
@@ -303,17 +315,23 @@ message LaneChangeAction
303315
//
304316
optional int32 relative_target_lane = 2;
305317

306-
// Specified shape of the lane change action.
318+
// Specified shape of the lane change action. This is optional:
319+
// If no dynamics shape is given, the shape of the lane change is
320+
// open to the traffic participant model.
307321
//
308322
optional DynamicsShape dynamics_shape = 3;
309323

310-
// Duration of the lane change.
324+
// Duration of the lane change. This is optional:
325+
// If no duration is given, the duration of the lane change is
326+
// open to the traffic participant model.
311327
//
312328
// Unit: s
313329
//
314330
optional double duration = 4;
315331

316-
// Distance of the lane change.
332+
// Distance of the lane change. This is optional:
333+
// If no distance is given, the distance of the lane change is
334+
// open to the traffic participant model.
317335
//
318336
// Unit: m
319337
//

0 commit comments

Comments
 (0)