OpenSimulationInterface · max-rosin · Mar 31, 2021 · Mar 31, 2021
diff --git a/doc/architecture/architecture_overview.adoc b/doc/architecture/architecture_overview.adoc
@@ -0,0 +1,11 @@
+= 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.
diff --git a/doc/architecture/coordinate_systems.adoc b/doc/architecture/coordinate_systems.adoc
@@ -0,0 +1,11 @@
+= Coordinate systems
+
+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.
diff --git a/doc/architecture/data_layer.adoc b/doc/architecture/data_layer.adoc
@@ -0,0 +1,10 @@
+= Data layer
+
+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.
diff --git a/doc/architecture/environmental_effect_model.adoc b/doc/architecture/environmental_effect_model.adoc
@@ -0,0 +1,10 @@
+= Environmental effect model
+
+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.
diff --git a/doc/architecture/feature_data.adoc b/doc/architecture/feature_data.adoc
@@ -0,0 +1,10 @@
+= Feature data
+
+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.
diff --git a/doc/architecture/formatting_scripts.adoc b/doc/architecture/formatting_scripts.adoc
@@ -0,0 +1,12 @@
+= Formatting scripts
+
+TODO: Add general description.
+
+osi2read.py::
+TODO: Add description.
+
+OSITrace.py::
+TODO: Add description.
+
+txt2osi.py::
+TODO: Add description.
diff --git a/doc/architecture/ground_truth.adoc b/doc/architecture/ground_truth.adoc
@@ -0,0 +1,10 @@
+= Ground truth
+
+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.
diff --git a/doc/architecture/logical_model.adoc b/doc/architecture/logical_model.adoc
@@ -0,0 +1,10 @@
+= Logical model
+
+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.
diff --git a/doc/architecture/packaging_layer.adoc b/doc/architecture/packaging_layer.adoc
@@ -0,0 +1,9 @@
+= Packaging layer
+
+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.
diff --git a/doc/architecture/proto-files.adoc b/doc/architecture/proto-files.adoc
@@ -0,0 +1,78 @@
+= Protobuffer files
+
+TODO: Add general description.
+
+osi_common.proto::
+TODO: Add description.
+
+osi_datarecording.proto::
+TODO: Add description.
+
+osi_detectedlane.proto::
+TODO: Add description.
+
+osi_detectedobject.proto::
+TODO: Add description.
+
+osi_detectedoccupant.proto::
+TODO: Add description.
+
+osi_detectedroadmarking.proto::
+TODO: Add description.
+
+osi_detectedtrafficlight.proto::
+TODO: Add description.
+
+osi_detectedtrafficsign.proto::
+TODO: Add description.
+
+osi_environment.proto::
+TODO: Add description.
+
+osi_featuredata.proto::
+TODO: Add description.
+
+osi_groundtruth.proto::
+TODO: Add description.
+
+osi_hostvehicledata.proto::
+TODO: Add description.
+
+osi_lane.proto::
+TODO: Add description.
+
+osi_logicaldetectiondata.proto::
+TODO: Add description.
+
+osi_object.proto::
+TODO: Add description.
+
+osi_occupant.proto::
+TODO: Add description.
+
+osi_roadmarking.proto::
+TODO: Add description.
+
+osi_sensordata.proto::
+TODO: Add description.
+
+osi_sensorspecific.proto::
+TODO: Add description.
+
+osi_sensorview.proto::
+TODO: Add description.
+
+osi_sensorviewconfiguration.proto::
+TODO: Add description.
+
+osi_trafficcommand.proto::
+TODO: Add description.
+
+osi_trafficlight.proto::
+TODO: Add description.
+
+osi_trafficsign.proto::
+TODO: Add description.
+
+osi_trafficupdate.proto::
+TODO: Add description.
diff --git a/doc/architecture/reference_points.adoc b/doc/architecture/reference_points.adoc
@@ -0,0 +1,10 @@
+= Reference points
+
+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.
diff --git a/doc/architecture/sensor_data.adoc b/doc/architecture/sensor_data.adoc
@@ -0,0 +1,9 @@
+= Sensor data
+
+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.
diff --git a/doc/architecture/sensor_model.adoc b/doc/architecture/sensor_model.adoc
@@ -0,0 +1,9 @@
+= Sensor model
+
+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.
diff --git a/doc/architecture/sensor_view.adoc b/doc/architecture/sensor_view.adoc
@@ -0,0 +1,9 @@
+= Sensor view
+
+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.
diff --git a/doc/architecture/sensor_view_configuration.adoc b/doc/architecture/sensor_view_configuration.adoc
@@ -0,0 +1,9 @@
+= Sensor view configuration
+
+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.
diff --git a/doc/architecture/test_scripts.adoc b/doc/architecture/test_scripts.adoc
@@ -0,0 +1,45 @@
+= Test scripts
+
+TODO: Add general description.
+
+__init__.py::
+TODO: Add description.
+
+test_comment_type.py::
+TODO: Add description.
+
+test_doxygen_output.py::
+TODO: Add description.
+
+test_invalid_comment.py::
+TODO: Add description.
+
+test_invalid_enum.py::
+TODO: Add description.
+
+test_invalid_html.py::
+TODO: Add description.
+
+test_invalid_message.py::
+TODO: Add description.
+
+test_invalid_punctuation.py::
+TODO: Add description.
+
+test_invalid_tabs.py::
+TODO: Add description.
+
+test_newline.py::
+TODO: Add description.
+
+test_non_ascii.py::
+TODO: Add description.
+
+test_osi_trace.py::
+TODO: Add description.
+
+test_rules.py::
+TODO: Add description.
+
+test_units.py::
+TODO: Add description.
diff --git a/doc/architecture/trace_file_formats.adoc b/doc/architecture/trace_file_formats.adoc
@@ -0,0 +1,9 @@
+= OSI trace file formats
+
+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.
diff --git a/doc/architecture/trace_file_naming.adoc b/doc/architecture/trace_file_naming.adoc
@@ -0,0 +1,9 @@
+= OSI trace file naming conventions
+
+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.
diff --git a/doc/architecture/traffic_participant.adoc b/doc/architecture/traffic_participant.adoc
@@ -0,0 +1,24 @@
+= Traffic participant
+
+A traffic participant is an element of the simulated world, which can change its state during simulation time, for example, position and orientation.
+A traffic participant represents one of the following:
+
+- A living being.
+- A means of transportation for living beings
+- A means of transportation for goods
+- Any other movable object that may travel the road network
+
+Pedestrians and animals are examples of traffic participants that are living beings.
+Vehicles are examples of traffic participants that are means of transportation.
+Therefore, the ego vehicle is also a traffic participant.
+
+The following figure shows the interface of a traffic participant.
+
+TODO: Add image of traffic participant interface.
+
+With every simulation step, an OSI traffic participant model receives ground truth data from the environment around itself, the sensor view.
+A traffic participant can output its own perceivable state, the traffic update.
+Traffic commands influence the behavior of the traffic participant model.
+They allow event-based communication towards the traffic participant, that is, at certain simulation steps.
+Traffic commands do not necessarily need to come from the environment simulation.
+They may come from a separate source, for example, a scenario engine.
diff --git a/doc/architecture/vehicle_dynamics.adoc b/doc/architecture/vehicle_dynamics.adoc
@@ -0,0 +1,9 @@
+= Vehicle dynamics
+
+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.