Skip to content

Commit

Permalink
document the expected format of the dict "_msger_veh_dict"
Browse files Browse the repository at this point in the history
  • Loading branch information
chengyuan0124 committed Sep 30, 2024
1 parent 881b7b7 commit 4d7922b
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions carma_messenger_vehicle_plugin/src/msger_veh_cfg.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,13 @@ def __init__(self, cfg_path, log_level='INFO'):
"""
Initializes the vehicle configuration manager by loading vehicle data from a JSON file.
Each vehicle's configuration is stored in the dictionary `_msger_veh_dict`, keyed by the vehicle's ID. This dictionary includes:
- 'route': list of strings representing the sequence of edges the vehicle will travel over in the simulation.
- 'speed': float, the maximum speed of the vehicle in meters per second.
- 'departureTime': int, the simulation time at which the vehicle starts.
- 'lcm': int, an integer representing the lane change mode using SUMO's encoding.
- 'cfm': str, the car following model that determines how the vehicle follows other vehicles.
Parameters:
- cfg_path: The file path to the JSON configuration file containing messenger vehicle data.
type: str
Expand Down

0 comments on commit 4d7922b

Please sign in to comment.