Skip to content

clarified semantics currently supported with TrafficUpdate #525

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

Merged
merged 3 commits into from
Aug 4, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions osi_trafficupdate.proto
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@ import "osi_object.proto";
package osi3;

//
// \brief The traffic update message is provided by traffic
// participant models to provide updates to their position, state
// and future trajectory back to the simulation environment.
// \brief The traffic update message is provided by traffic participant
// models to provide updates to their position, state and future
// trajectory back to the simulation environment. The message is
// designed to update data of exactly one traffic participant,
// optionally with an attached trailer.
//
// \note For reasons of convenience and consistency, the
// updated information is provided as a MovingObject. Certain fields
// of this sub-message are not required to be set and will be ignored by the
// \note For reasons of convenience and consistency, the updated
// information is provided as a MovingObject. Certain fields of this
// sub-message are not required to be set and will be ignored by the
// simulation environment, because they are static information.
// Instead of creating a seperate message type for only the non-static
// information, re-use existing message.
Expand Down Expand Up @@ -45,5 +47,9 @@ message TrafficUpdate
// or vehicle category. All dynamic fields should be populated where known,
// for example, velocity, light states, or future trajectory.
//
// \note The field is repeated because it is possible to have a trailer attached to
// a vehicle, see MovingObject::VehicleClassification::has_trailer and
// MovingObject::VehicleClassification::trailer_id.
//
repeated MovingObject update = 3;
}