Skip to content
Merged
Show file tree
Hide file tree
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
46 changes: 37 additions & 9 deletions doc/architecture/architecture_overview.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,39 @@
= Overview of OSI architecture

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Et malesuada fames ac turpis egestas.
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
Sed augue lacus viverra vitae congue eu.
Velit ut tortor pretium viverra suspendisse.
Amet commodo nulla facilisi nullam vehicula ipsum a.
Nibh nisl condimentum id venenatis a.
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.
OSI contains an object-based environment description using the message format of the https://github.com/protocolbuffers/protobuf/wiki[Protocol Buffer] library developed and maintained by Google.
OSI defines top-level messages that are used to exchange data between separate models.
Top-level messages define the ``GroundTruth`` interface, the ``SensorData`` interface and, since OSI version 3.0.0, the ``SensorView``, ``SensorViewConfiguration`` and ``FeatureData`` interfaces.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is right, but maybe HostVehicleData has to be added here (depending on CCB-decission).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

trafficCommand, trafficUpdate?

Copy link
Contributor Author

@max-rosin max-rosin Jul 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added text that mentions these three interfaces. Please check out 7e3325c.


The following figure shows the interfaces and models involved in modeling a sensor.

.Open Simulation Interface overview
image::osi-context.png[1100]


OSI also defines interfaces for traffic participant models.
The ``TrafficCommand`` interface allows to send commands to traffic participant models.
The ``TrafficUpdate`` interface allows to receive their updated state.
The following figure shows the interfaces of a generic traffic participant.

.Interface of a traffic participant
image::osi-traffic-participant-principle.png[1100]

Traffic participant models may use other OSI interfaces internally, for example, to model autonomous vehicles.
The following figure shows a more advanced use case for traffic participants.

.Traffic participant with sensor models, AD function, and dynamic model
image::osi-traffic-participant-advanced.png[1100]

The ``HostVehicleData`` interface describes the measured internal states of a traffic participant
OSI currently provides only limited support for data structures describing measured internal states traffic participants.
Actuator intentions are currently not covered by OSI and must be handled with a different data description format.

All fields in an interface are set to `optional`.
`required` is not used.
This has been done to allow backward-compatible changes in the field.
Additionally, this is the default behavior in Protocol Buffer version 3 that does no longer have the `required` type and therefore ensures update compatibility.
However, this does not mean that filling the field is optional.
For the purpose of providing a complete interface, all existing fields should be set, unless not setting a field carries a specific meaning as indicated in the accompanying comment.

All field numbers equal to or greater than 10000 are available for user-specific extensions via custom fields.
Therefore, no future evolution of OSI will use field numbers equal to or greater than 10000.
Binary file added doc/images/osi-context.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/osi-traffic-participant-advanced.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/osi-traffic-participant-principle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.