Skip to content

Commit 546aa8a

Browse files
max-rosinmax-rosin
committed
feat(docs): Create initial document structure (#494)
Signed-off-by: Maximilian Rosin <maximilian.rosin@parson-europe.com>
1 parent a9e6a71 commit 546aa8a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+612
-1414
lines changed

‎doc/architecture/architecture_overview.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= Overview of OSI architecture
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu.
8+
Velit ut tortor pretium viverra suspendisse.
9+
Amet commodo nulla facilisi nullam vehicula ipsum a.
10+
Nibh nisl condimentum id venenatis a.
11+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/coordinate_systems.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= Coordinate systems
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu.
8+
Velit ut tortor pretium viverra suspendisse.
9+
Amet commodo nulla facilisi nullam vehicula ipsum a.
10+
Nibh nisl condimentum id venenatis a.
11+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/data_layer.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
= Data layer
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8+
Amet commodo nulla facilisi nullam vehicula ipsum a.
9+
Nibh nisl condimentum id venenatis a.
10+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/environmental_effect_model.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
= Environmental effect model
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8+
Amet commodo nulla facilisi nullam vehicula ipsum a.
9+
Nibh nisl condimentum id venenatis a.
10+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/feature_data.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
= Feature data
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8+
Amet commodo nulla facilisi nullam vehicula ipsum a.
9+
Nibh nisl condimentum id venenatis a.
10+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/formatting_scripts.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
= Formatting scripts
2+
3+
TODO: Add general description.
4+
5+
osi2read.py::
6+
TODO: Add description.
7+
8+
OSITrace.py::
9+
TODO: Add description.
10+
11+
txt2osi.py::
12+
TODO: Add description.

‎doc/architecture/ground_truth.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
= Ground truth
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8+
Amet commodo nulla facilisi nullam vehicula ipsum a.
9+
Nibh nisl condimentum id venenatis a.
10+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/logical_model.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
= Logical model
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8+
Amet commodo nulla facilisi nullam vehicula ipsum a.
9+
Nibh nisl condimentum id venenatis a.
10+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/packaging_layer.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
= Packaging layer
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8+
Amet commodo nulla facilisi nullam vehicula ipsum a. Nibh nisl condimentum id venenatis a.
9+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/proto-files.adoc

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
= Protobuffer files
2+
3+
TODO: Add general description.
4+
5+
osi_common.proto::
6+
TODO: Add description.
7+
8+
osi_datarecording.proto::
9+
TODO: Add description.
10+
11+
osi_detectedlane.proto::
12+
TODO: Add description.
13+
14+
osi_detectedobject.proto::
15+
TODO: Add description.
16+
17+
osi_detectedoccupant.proto::
18+
TODO: Add description.
19+
20+
osi_detectedroadmarking.proto::
21+
TODO: Add description.
22+
23+
osi_detectedtrafficlight.proto::
24+
TODO: Add description.
25+
26+
osi_detectedtrafficsign.proto::
27+
TODO: Add description.
28+
29+
osi_environment.proto::
30+
TODO: Add description.
31+
32+
osi_featuredata.proto::
33+
TODO: Add description.
34+
35+
osi_groundtruth.proto::
36+
TODO: Add description.
37+
38+
osi_hostvehicledata.proto::
39+
TODO: Add description.
40+
41+
osi_lane.proto::
42+
TODO: Add description.
43+
44+
osi_logicaldetectiondata.proto::
45+
TODO: Add description.
46+
47+
osi_object.proto::
48+
TODO: Add description.
49+
50+
osi_occupant.proto::
51+
TODO: Add description.
52+
53+
osi_roadmarking.proto::
54+
TODO: Add description.
55+
56+
osi_sensordata.proto::
57+
TODO: Add description.
58+
59+
osi_sensorspecific.proto::
60+
TODO: Add description.
61+
62+
osi_sensorview.proto::
63+
TODO: Add description.
64+
65+
osi_sensorviewconfiguration.proto::
66+
TODO: Add description.
67+
68+
osi_trafficcommand.proto::
69+
TODO: Add description.
70+
71+
osi_trafficlight.proto::
72+
TODO: Add description.
73+
74+
osi_trafficsign.proto::
75+
TODO: Add description.
76+
77+
osi_trafficupdate.proto::
78+
TODO: Add description.

‎doc/architecture/reference_points.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
= Reference points
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8+
Amet commodo nulla facilisi nullam vehicula ipsum a.
9+
Nibh nisl condimentum id venenatis a.
10+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/sensor_data.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
= Sensor data
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8+
Amet commodo nulla facilisi nullam vehicula ipsum a. Nibh nisl condimentum id venenatis a.
9+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/sensor_model.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
= Sensor model
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8+
Amet commodo nulla facilisi nullam vehicula ipsum a. Nibh nisl condimentum id venenatis a.
9+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/sensor_view.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
= Sensor view
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8+
Amet commodo nulla facilisi nullam vehicula ipsum a. Nibh nisl condimentum id venenatis a.
9+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/sensor_view_configuration.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
= Sensor view configuration
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8+
Amet commodo nulla facilisi nullam vehicula ipsum a. Nibh nisl condimentum id venenatis a.
9+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/test_scripts.adoc

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
= Test scripts
2+
3+
TODO: Add general description.
4+
5+
__init__.py::
6+
TODO: Add description.
7+
8+
test_comment_type.py::
9+
TODO: Add description.
10+
11+
test_doxygen_output.py::
12+
TODO: Add description.
13+
14+
test_invalid_comment.py::
15+
TODO: Add description.
16+
17+
test_invalid_enum.py::
18+
TODO: Add description.
19+
20+
test_invalid_html.py::
21+
TODO: Add description.
22+
23+
test_invalid_message.py::
24+
TODO: Add description.
25+
26+
test_invalid_punctuation.py::
27+
TODO: Add description.
28+
29+
test_invalid_tabs.py::
30+
TODO: Add description.
31+
32+
test_newline.py::
33+
TODO: Add description.
34+
35+
test_non_ascii.py::
36+
TODO: Add description.
37+
38+
test_osi_trace.py::
39+
TODO: Add description.
40+
41+
test_rules.py::
42+
TODO: Add description.
43+
44+
test_units.py::
45+
TODO: Add description.

‎doc/architecture/trace_file_formats.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
= OSI trace file formats
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8+
Amet commodo nulla facilisi nullam vehicula ipsum a. Nibh nisl condimentum id venenatis a.
9+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/trace_file_naming.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
= OSI trace file naming conventions
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8+
Amet commodo nulla facilisi nullam vehicula ipsum a. Nibh nisl condimentum id venenatis a.
9+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/architecture/traffic_participant.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
= Traffic participant
2+
3+
A traffic participant is an element of the simulated world, which can change its state during simulation time, for example, position and orientation.
4+
A traffic participant represents one of the following:
5+
6+
- A living being.
7+
- A means of transportation for living beings
8+
- A means of transportation for goods
9+
- Any other movable object that may travel the road network
10+
11+
Pedestrians and animals are examples of traffic participants that are living beings.
12+
Vehicles are examples of traffic participants that are means of transportation.
13+
Therefore, the ego vehicle is also a traffic participant.
14+
15+
The following figure shows the interface of a traffic participant.
16+
17+
TODO: Add image of traffic participant interface.
18+
19+
With every simulation step, an OSI traffic participant model receives ground truth data from the environment around itself, the sensor view.
20+
A traffic participant can output its own perceivable state, the traffic update.
21+
Traffic commands influence the behavior of the traffic participant model.
22+
They allow event-based communication towards the traffic participant, that is, at certain simulation steps.
23+
Traffic commands do not necessarily need to come from the environment simulation.
24+
They may come from a separate source, for example, a scenario engine.

‎doc/architecture/vehicle_dynamics.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
= Vehicle dynamics
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse.
8+
Amet commodo nulla facilisi nullam vehicula ipsum a. Nibh nisl condimentum id venenatis a.
9+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

0 commit comments

Comments
 (0)