Skip to content

Commit eb11168

Browse files
authored
Merge pull request #167 from OpenSimulationInterface/Documentation-Review3
Review documentation and add BaseStationary to supplementary signs
2 parents c4862a9 + 7327dd7 commit eb11168

19 files changed

+2527
-1658
lines changed

osi_common.proto

Lines changed: 113 additions & 77 deletions
Large diffs are not rendered by default.

osi_datarecording.proto

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,20 @@ import "osi_sensordata.proto";
77
package osi;
88

99
//
10-
// \brief (Time) Series of SensorData messages that may be used for data
10+
// \brief (Time) Series of \c SensorData messages that may be used for data
1111
// recording or internal buffering by some sensor models.
1212
//
1313
message SensorDataSeries
1414
{
1515
// List of sensor data messages for subsequent timesteps.
1616
//
17-
repeated SensorData sensor_data_list = 1;
17+
// \note OSI uses singular instead of plural for repeated field names.
18+
//
19+
repeated SensorData sensor_data = 1;
1820
}
1921

2022
//
21-
// \brief List of SensorData interface copies, one for each sensor in the
23+
// \brief List of \c SensorData interface copies, one for each sensor in the
2224
// vehicle.
2325
//
2426
// Can be used to bundle output of multiple sensors in one transmission.
@@ -27,16 +29,18 @@ message SensorDataList
2729
{
2830
// List of sensor data for multiple sensors at a specific timestep.
2931
//
30-
repeated SensorData sensors = 1;
32+
repeated SensorData sensor = 1;
3133
}
3234

3335
//
3436
// \brief List of sensors where each element contains a time series of
35-
// SensorData messages.
37+
// \c SensorData messages.
3638
//
3739
message SensorDataSeriesList
3840
{
3941
// List of sensor data for multiple sensors at subsequent timesteps.
4042
//
41-
repeated SensorDataSeries sensors = 1;
43+
// \note OSI uses singular instead of plural for repeated field names.
44+
//
45+
repeated SensorDataSeries sensor = 1;
4246
}

0 commit comments

Comments
 (0)