Skip to content

Commit e78dff7

Browse files
Issue #836: Added missing pages and linked them in navigation. (#838)
* Issue #836: Added links to interface specification pages. ---------- Signed-off-by: Philip WINDECKER (AVENYR GmbH) <[email protected]> Co-authored-by: Carlo van Driesten <[email protected]>
1 parent 15bc016 commit e78dff7

12 files changed

+62
-11
lines changed

Diff for: doc/architecture/architecture_overview.adoc

+14-4
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,21 @@ include::{root-path}_config.adoc[]
44
endif::[]
55
= Overview of OSI architecture
66

7-
OSI contains an object-based environment description that uses the message format of the https://github.com/protocolbuffers/protobuf/wiki[Protocol Buffer] library.
8-
Google developed and maintains the Protocol Buffer library.
7+
OSI contains an object-based environment description that uses the message format of the https://github.com/protocolbuffers/protobuf/wiki[Protocol Buffer^] library developed by Google.
98
OSI defines top-level messages that are used to exchange data between separate models.
10-
Top-level messages define the `GroundTruth` interface, the `SensorData` interface, and – since OSI version 3.0.0 – the interfaces `SensorView` and `SensorViewConfiguration`.
11-
Further top-level messages that were added in later versions of OSI are `HostVehicleData`, `TrafficCommand`, `TrafficCommandUpdate`, `TrafficUpdate`, `MotionRequest`, and `StreamingUpdate`.
9+
10+
Top-level messages define the following interfaces:
11+
12+
- xref:architecture/ground_truth.adoc[`GroundTruth`]
13+
- xref:architecture/sensor_data.adoc[`SensorData`]
14+
- xref:architecture/sensor_view.adoc[`SensorView`]
15+
- xref:architecture/sensor_view_configuration.adoc[`SensorViewConfiguration`]
16+
- xref:architecture/host_vehicle_data.adoc[`HostVehicleData`]
17+
- xref:architecture/traffic_command.adoc[`TrafficCommand`]
18+
- xref:architecture/traffic_command_update.adoc[`TrafficCommandUpdate`]
19+
- xref:architecture/traffic_update.adoc[`TrafficUpdate`]
20+
- xref:architecture/motion_request.adoc[`MotionRequest`]
21+
- xref:architecture/streaming_update.adoc[`StreamingUpdate`].
1222
1323
The following figure shows the interfaces and models involved in modeling a sensor.
1424

Diff for: doc/architecture/ground_truth.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,6 @@ endif::[]
66

77
`GroundTruth` messages describe the simulated environment containing all simulated objects in the global coordinate system at consecutive time instances.
88
They are based on data available to the simulation environment.
9-
`GroundTruth` messages are typically contained in `Sensorview` messages.
9+
`GroundTruth` messages are typically contained in `Sensorview` messages.
10+
11+
For more details, see xref:gen:structosi3_1_1GroundTruth.adoc[].

Diff for: doc/architecture/host_vehicle_data.adoc

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
ifndef::include-only-once[]
2+
:root-path: ../
3+
include::{root-path}_config.adoc[]
4+
endif::[]
5+
= Host vehicle data
6+
7+
The `HostVehicleData` message targets the perception of the vehicle of its own internal states.
8+
9+
It captures the knowledge the vehicle has internally, which can differ from the actual or global truth for various reasons.
10+
This message can also be understood as an interface container for the signals of a rest bus simulation.
11+
12+
For more details, see xref:gen:structosi3_1_1HostVehicleData.adoc[].

Diff for: doc/architecture/motion_request.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,6 @@ endif::[]
55
= Motion Request
66

77
`MotionRequest` messages are traffic participant internal messages.
8-
They function as a interface between a motion/behavior planning model and a dynamics model including, for example, controllers and vehicle kinematics.
8+
They function as a interface between a motion/behavior planning model and a dynamics model including, for example, controllers and vehicle kinematics.
9+
10+
For more details, see xref:gen:structosi3_1_1MotionRequest.adoc[].

Diff for: doc/architecture/sensor_data.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ Sensor data can be used as input for an automated driving function, a sensor mod
1313
`SensorData` messages include `FeatureData` messages which contain detected features in the reference frame of a sensor.
1414
`FeatureData` messages are generated from `GroundTruth` messages.
1515
They serve, for example, as an input to sensor models simulating object detection or feature fusion models.
16+
17+
For more details, see xref:gen:structosi3_1_1SensorData.adoc[].

Diff for: doc/architecture/sensor_view.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,6 @@ All information regarding the environment is given with respect to the virtual s
1010

1111
* Physical technology-specific data, given with respect to the physical sensor coordinate system specified in the corresponding physical sensor's mounting position.
1212
One example of technology-specific data is: xref:gen:structosi3_1_1CameraSensorView.adoc#ac58456a34babf78792ea2608eb963f36[`image_data` of `osi3::CameraSensorView`]
13-
* Ground truth given in the global coordinate system.
13+
* Ground truth given in the global coordinate system.
14+
15+
For more details, see xref:gen:structosi3_1_1SensorView.adoc[].

Diff for: doc/architecture/sensor_view_configuration.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,6 @@ In response to this difference, the sensor model can either accept this differen
3535

3636
The packaging layer defines the specifics of this auto-negotiation mechanism.
3737

38-
After the initialization phase, the environment simulation provides the actual sensor-view configuration as part of each `SensorView` message.
38+
After the initialization phase, the environment simulation provides the actual sensor-view configuration as part of each `SensorView` message.
39+
40+
For more details, see xref:gen:structosi3_1_1SensorViewConfiguration.adoc[].

Diff for: doc/architecture/streaming_update.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ endif::[]
77
The `StreamingUpdate` message provides an interface to transmit a subset of ground truth and/or vehicle internal data.
88
This interface mainly addresses applications with low latency requirements and no need for highly consistent and complete data, e.g. visualization applications.
99
Static and/or non-relevant objects can be omitted as required for the specific use case.
10-
Note that the receiver of partial updates can only rely on the most up-to-date information at the corresponding timestamp. E.g. omitting objects does not indicate static behaviour but it may be sufficient for the use case to update certain objects at a later point in time.
10+
Note that the receiver of partial updates can only rely on the most up-to-date information at the corresponding timestamp. E.g. omitting objects does not indicate static behavior but it may be sufficient for the use case to update certain objects at a later point in time.
11+
12+
For more details, see xref:gen:structosi3_1_1StreamingUpdate.adoc[].

Diff for: doc/architecture/traffic_command.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,6 @@ include::{root-path}_config.adoc[]
44
endif::[]
55
= Traffic command
66

7-
`TrafficCommand` messages contain control commands from the scenario engine to traffic participant models.
7+
`TrafficCommand` messages contain control commands from the scenario engine to traffic participant models.
8+
9+
For more details, see xref:gen:structosi3_1_1TrafficCommand.adoc[].

Diff for: doc/architecture/traffic_command_update.adoc

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
ifndef::include-only-once[]
2+
:root-path: ../
3+
include::{root-path}_config.adoc[]
4+
endif::[]
5+
= Traffic command update
6+
7+
`TrafficCommandUpdate` messages enable the traffic participant model to send updates to the scenario engine about the execution of its received xref:architecture/traffic_command.adoc[TrafficCommand] input.
8+
9+
For more details, see xref:gen:structosi3_1_1TrafficCommandUpdate.adoc[].

Diff for: doc/architecture/traffic_update.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,6 @@ endif::[]
55
= Traffic update
66

77
`TrafficUpdate` messages are provided by traffic participants.
8-
They provide updates on the position, state, and future trajectory of a traffic participant back to the simulation environment.
8+
They provide updates on the position, state, and future trajectory of a traffic participant back to the simulation environment.
9+
10+
For more details, see xref:gen:structosi3_1_1TrafficUpdate.adoc[].

Diff for: doc/open-simulation-interface_user_guide.adoc

+4
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,12 @@ include::./architecture/sensor_view_configuration.adoc[leveloffset=+3]
2121

2222
include::./architecture/sensor_data.adoc[leveloffset=+3]
2323

24+
include::./architecture/host_vehicle_data.adoc[leveloffset=+3]
25+
2426
include::./architecture/traffic_command.adoc[leveloffset=+3]
2527

28+
include::./architecture/traffic_command_update.adoc[leveloffset=+3]
29+
2630
include::./architecture/motion_request.adoc[leveloffset=+3]
2731

2832
include::./architecture/traffic_update.adoc[leveloffset=+3]

0 commit comments

Comments
 (0)