docs(TrajectoryPoint): add comment for acceleration_mps2 to clarify i…

…ts usage (#47) Signed-off-by: Ahmed Ebrahim <[email protected]>
tier4 · Jul 2, 2024 · 624aae9 · 624aae9
1 parent 1e8b6d2
commit 624aae9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/autoware_auto_msgs/design/autoware_auto_msgs-design.md b/autoware_auto_msgs/design/autoware_auto_msgs-design.md
@@ -64,6 +64,8 @@ float32 front_wheel_angle_rad 0.0
 float32 rear_wheel_angle_rad 0.0
 ```
 
+> `acceleration_mps2` increases/decreases based on absolute vehicle motion and does not consider vehicle direction (forward/backward)
+
 And the heading field has the following form:
 
 A zero heading corresponds to the positive x direction in the given coordinate frame.

diff --git a/autoware_auto_planning_msgs/msg/TrajectoryPoint.idl b/autoware_auto_planning_msgs/msg/TrajectoryPoint.idl
@@ -17,7 +17,8 @@ module autoware_auto_planning_msgs {
       float lateral_velocity_mps;
 
       @default (value=0.0)
-      float acceleration_mps2;
+      // acceleration_mps2 increases/decreases based on absolute vehicle motion and does not consider vehicle direction (forward/backward)
+      float acceleration_mps2; 
 
       @default (value=0.0)
       float heading_rate_rps;