Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add documentation describing the traffic–vehicle co-simulation message flow used in the FIXS framework.
This PR introduces a new documentation page that explains the interaction between the following components:
The document also includes several message flow diagrams that illustrate:
These diagrams aim to make the system architecture easier to understand for developers and new contributors.
Related Issues / Tasks
PR 3 for #122
Type of Change
Affected Modules / Components
Documentation under:
doc/FIXS_message_flow.md
doc/images/
New diagrams added:
FIXS_final_model.pngMessage_flow_1.pngMessage_flow_2.pngMessage_flow_3.pngTest Cases
No runtime tests are required for this PR since it only introduces documentation and architecture diagrams.
Environment
Not applicable (documentation update only).
Checklist
Additional Notes (optional)
The message flow diagrams are intended to clarify the data exchange between traffic simulation and high-fidelity vehicle dynamics in the co-simulation framework.
They also distinguish between:
This documentation is meant to support future development and improve onboarding for contributors working on the co-simulation architecture.