add comment of vehicle state

usdot-fhwa-stol · Sep 25, 2024 · afabf7c · afabf7c
1 parent f916410
commit afabf7c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/carma_messenger_vehicle_plugin/src/msger_veh_cfg.py b/carma_messenger_vehicle_plugin/src/msger_veh_cfg.py
@@ -147,6 +147,9 @@ def set_veh_state(self, veh_id, state):
         Parameters:
         - veh_id: The ID of the vehicle.
         - state: The new state to set for the vehicle.
+        * 0: vehicle not created
+        * 1: vehicle is created and is driving in the scene
+        * 2: vehicle is created but finish the route and destroyed
         type: int
         """
         if veh_id in self._veh_state_dict: