Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TrafficCommandUpdate missing from trace file name documentation #816

Closed
ClemensLinnhoff opened this issue May 27, 2024 · 3 comments
Closed
Assignees
Labels
Bug Problems in the build system, build scripts, etc or faults in the interface. Documentation Everything which impacts the quality of the documentation and guidelines.
Milestone

Comments

@ClemensLinnhoff
Copy link
Contributor

Describe the bug

The trace file naming convention in the documentation lists possible types of top-level messages. However, the TrafficCommandUpdate is missing. I propose to use 'tcu' as an abbreviation.

Show some screenshots

image

@ClemensLinnhoff ClemensLinnhoff added the Documentation Everything which impacts the quality of the documentation and guidelines. label May 27, 2024
@ClemensLinnhoff ClemensLinnhoff added this to the V3.7.1 milestone May 27, 2024
@jdsika jdsika added the Bug Problems in the build system, build scripts, etc or faults in the interface. label Jun 3, 2024
@ClemensLinnhoff
Copy link
Contributor Author

The TrafficCommandUpdate is also missing from section 2.2.2 of the documentation:

image

@pmai pmai closed this as completed in ceeb575 Jun 10, 2024
@xuanyuxin
Copy link

I have a similar question. Why does 2.2.2 Top-level interfaces only have these classes i.e. how to include other classes mentioned in classes so that I can have these msg available in the trace file. Thanks!

@ClemensLinnhoff
Copy link
Contributor Author

Chapter 2.2.2 only lists possible top-level messages. Other messages listed in the classes are contained in these top-level messages. Also, top-level messages can contain other messages, that can also be used as top-level messages. For example: A SensorData message can contain a SensorView message. But you could also use SensorView by its own.

This is also reflected in the possible trace file types, described here. To give an example: You can have a GroundTruth trace file containing MovingObjects. But you cannot have a MovingObject trace file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Problems in the build system, build scripts, etc or faults in the interface. Documentation Everything which impacts the quality of the documentation and guidelines.
Projects
None yet
Development

No branches or pull requests

4 participants