Skip to content

Commit 1ee24bc

Browse files
paagkamepmai
authored andcommitted
Linguistic review of MotionRequest
Signed-off-by: Katrin Mehl <katrin.mehl@parson-europe.com>
1 parent 7637bf3 commit 1ee24bc

File tree

3 files changed

+20
-14
lines changed

3 files changed

+20
-14
lines changed

osi_motionrequest.proto

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ package osi3;
1010
//
1111
// \brief This message is intended as an interface between a HAD (highly automated driving) function and the actuator management.
1212
// The HAD function can send either a desired future trajectory ore a desired future state.
13-
// The message to be used can be defined by a additional variable.
13+
// The message can be defined by a additional variable.
1414
//
1515
// All coordinates and orientations are relative to the global coordinate system.
1616
// The reference point of the vehicle is the center of the 3D bounding box of the vehicle.
@@ -19,7 +19,7 @@ message MotionRequest
1919
{
2020

2121
//
22-
// Define different options for had function ouput.
22+
// Define different options for HAD function ouput.
2323
// Each option is corresponds to a field in the message.
2424
//
2525
enum OutputOptions {
@@ -29,25 +29,25 @@ message MotionRequest
2929

3030
//
3131
// Define the option that is used to specify the motion request.
32-
// This must be set. Additionaly the field corresponding to the specified option must be set.
32+
// This must be set. Additionally, the field corresponding to the specified option must be set.
3333
//
3434
optional OutputOptions output_option = 1;
3535

3636
//
3737
// Defines a desired state.
38-
// If the output option is set to DESIRED_STATE this must be provided.
38+
// If the output option is set to DESIRED_STATE, this must be provided.
3939
//
4040
optional DesiredState desired_state = 2;
4141

4242
//
4343
// Defines a desired trajectory.
44-
// If the output option is set to DESIRED_TRAJECTORY this must be set.
44+
// If the output option is set to DESIRED_TRAJECTORY, this must be set.
4545
//
4646
optional Trajectory desired_trajectory = 3;
4747
}
4848

4949
//
50-
// \brief Defined the trajectory desired by the had function. This trajectory is the result of the trajctory planning step
50+
// \brief Defined the trajectory desired by the HAD function. This trajectory is the result of the trajctory planning step
5151
// in the HAD function. The task of the acutator management is to follow the trajectory as close as possible.
5252
// The timestamps inside the trajecotry must be defined in global simulation time.
5353
//
@@ -56,30 +56,30 @@ message Trajectory {
5656
}
5757

5858
//
59-
// \brief The desired state calculated by the had function as a result of the motion planning stack.
59+
// \brief The desired state calculated by the HAD function as a result of the motion planning stack.
6060
// The actuator management is supposed
6161
//
6262
message DesiredState
6363
{
6464
//
65-
// The timestamp indicates at which point in time the state needs to be reached,
65+
// The timestamp indicates the point in time the state needs to be reached,
6666
// given in global simulation time.
6767
//
6868
optional Timestamp timestamp = 1;
6969

70-
// intended position to be reached in x, y and z direction.
70+
// intended position to be reached in x, y, and z direction.
7171
//
7272
optional Vector3d position = 2;
7373

74-
// intended orientation to be reached containing roll, pitch and yaw angle
74+
// intended orientation to be reached containing roll, pitch, and yaw angle
7575
//
7676
optional Orientation3d orientation = 3;
7777

78-
// intended velocity to be reached in x, y and z direction
78+
// intended velocity to be reached in x, y, and z direction
7979
//
8080
optional Vector3d velocity = 4;
8181

82-
// intended acceleration to be reached in x, y and z direction
82+
// intended acceleration to be reached in x, y, and z direction
8383
//
8484
optional Vector3d acceleration = 5;
8585

osi_object.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -449,8 +449,8 @@ message MovingObject
449449
// realistic simulation of traffic participants that are not under test.
450450
// This information should not be made available to the stack under test.
451451
//
452-
// \note Moving objects are not required to stick to this trajectory, it is
453-
// indicative, and equivalent to the output of a perception + prediction
452+
// \note Moving objects are not required to stick to this trajectory. It is
453+
// indicative and equivalent to the output of a perception and prediction
454454
// system.
455455
//
456456
repeated StatePoint future_trajectory = 8;

osi_trafficupdate.proto

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,17 @@ import "osi_hostvehicledata.proto";
1010
package osi3;
1111

1212
//
13+
<<<<<<< HEAD
1314
// \brief The traffic update message is provided by traffic participant
1415
// models to provide updates to their position, state and future
1516
// trajectory back to the simulation environment. The message is
1617
// designed to update data of exactly one traffic participant,
1718
// optionally with an attached trailer.
19+
=======
20+
// \brief The traffic update message is provided by traffic
21+
// participant models to provide updates to their position, state,
22+
// and future trajectory back to the simulation environment.
23+
>>>>>>> 9af16d40 (feat (docs): grammar)
1824
//
1925
// \note For reasons of convenience and consistency, the updated
2026
// information is provided as a MovingObject. Certain fields of this

0 commit comments

Comments
 (0)