Skip to content

Commit ade71ce

Browse files
max-rosinlemmer-fzi
authored andcommitted
fix(docs): Fix minor typos, reflow comments
Signed-off-by: Maximilian Rosin <maximilian.rosin@parson-europe.com> Signed-off-by: Markus Lemmer <lemmer@fzi.de>
1 parent 0af514d commit ade71ce

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

osi_motionrequest.proto

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ import "osi_version.proto";
88
package osi3;
99

1010
//
11-
// \brief This message is intended as an interface between a HAD (highly automated driving) function and the actuator management.
11+
// \brief This message is intended as an interface between a
12+
// highly-automated-driving function (HAD function) and the actuator management.
1213
//
13-
// The HAD function can send either a desired future trajectory or a desired future state.
14-
// The message can be defined by an additional variable.
14+
// The HAD function can either send a desired future trajectory or a desired
15+
// future state. The message can be defined by an additional variable.
1516
//
1617
// \note The coordinate system is defined as right-handed.
1718
// All coordinates and orientations are relative to the global coordinate system.
@@ -24,12 +25,14 @@ message MotionRequest
2425
//
2526
optional InterfaceVersion version = 1;
2627

27-
// The data timestamp of the simulation environment. A reference to \c Timestamp message.
28+
// The data timestamp of the simulation environment.
29+
// A reference to \c Timestamp message.
2830
//
2931
optional Timestamp timestamp = 2;
3032

3133
// Define the option that is used to specify the motion request.
32-
// This must be set. Additionally, the field corresponding to the specified option must be set.
34+
// This must be set. Additionally, the field corresponding to the specified
35+
// option must be set.
3336
//
3437
optional OutputOptions output_option = 3;
3538

@@ -57,31 +60,33 @@ message MotionRequest
5760
OUTPUT_OPTIONS_TRAJECTORY = 1;
5861
}
5962

60-
// \brief The desired state is calculated by the HAD function as a result of the motion planning stack.
63+
// \brief The desired state is calculated by the HAD function as a result of
64+
// the motion planning stack.
6165
//
62-
// The actuator management is supposed to reach the desired state at the specified time.
66+
// The actuator management is supposed to reach the desired state at the
67+
// specified time.
6368
//
6469
message DesiredState
6570
{
6671
// A reference to \c Timestamp message.
6772
//
6873
optional Timestamp timestamp = 1;
6974

70-
// Intended position to be reached in x, y, and z direction.
75+
// Intended position to be reached in in x-, y-, and z-direction.
7176
//
7277
optional Vector3d position = 2;
7378

7479
// Intended orientation to be reached containing yaw, pitch and roll angle.
7580
//
7681
optional Orientation3d orientation = 3;
7782

78-
// Intended velocity to be reached in x, y, and z direction.
83+
// Intended velocity to be reached in in x-, y-, and z-direction.
7984
//
8085
// Unit: m/s
8186
//
8287
optional Vector3d velocity = 4;
8388

84-
// Intended acceleration to be reached in x, y, and z direction.
89+
// Intended acceleration to be reached in x-, y-, and z-direction.
8590
//
8691
// Unit: m/s^2
8792
//
@@ -94,11 +99,12 @@ message MotionRequest
9499
// The task of the actuator management is to follow this trajectory as closely as possible.
95100
// The timestamps inside the trajectory must be defined in global simulation time.
96101
//
97-
// \note Trajectory is kept as a separate message for future extensions.
102+
// \note The trajectory is kept as a separate message for future extensions.
98103
//
99104
message Trajectory
100105
{
101-
// Consists of intended position (x, y, and z) and orientation (yaw, pitch and roll) of intended state to be reached.
106+
// The trajectory consists of intended position (x, y, and z) and
107+
// orientation (yaw, pitch and roll) of intended state to be reached.
102108
// A reference to \c StatePoint message.
103109
//
104110
repeated StatePoint trajectory_point = 1;

0 commit comments

Comments
 (0)