Skip to content

Commit 4220d86

Browse files
committed
docs: deprecate SensorDataSeries and SensorDataSeriesList for removal in v4.0.0
The single-channel (.osi) and multi-channel (.mcap) trace file formats have fully superseded these messages: - .osi traces generalize SensorDataSeries to any top-level message type and support streaming without loading all timesteps into memory. - .mcap traces generalize SensorDataSeriesList to any combination of top-level message types with metadata, schemas, compression, and random access. Internal buffering by sensor models is an implementation concern and does not belong in the interface specification. Resolves #900 Signed-off-by: Carlo van Driesten <carlo.van-driesten@bmw.de>
1 parent 083481d commit 4220d86

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

osi_datarecording.proto

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,14 @@ import "osi_sensordata.proto";
77
package osi3;
88

99
//
10-
// \brief (Time) Series of \c SensorData messages that may be used for data
11-
// recording or internal buffering by some sensor models.
10+
// \brief (Time) Series of \c SensorData messages.
11+
//
12+
// \attention DEPRECATED: This message will be removed in OSI 4.0.0.
13+
// Use the OSI trace file formats instead, which generalize
14+
// the concept to any top-level message type and support streaming
15+
// without requiring all time steps to be held in memory at once.
16+
// Internal buffering by sensor models should be handled within the
17+
// sensor model implementation.
1218
//
1319
message SensorDataSeries
1420
{
@@ -21,6 +27,11 @@ message SensorDataSeries
2127
// \brief List of sensors where each element contains a time series of
2228
// \c SensorData messages.
2329
//
30+
// \attention DEPRECATED: This message will be removed in OSI 4.0.0.
31+
// Use the OSI trace file formats instead, which generalize
32+
// the concept to any combination of top-level message types and
33+
// provide metadata, schema records, compression, and random access.
34+
//
2435
message SensorDataSeriesList
2536
{
2637
// List of sensor data for multiple sensors at subsequent time steps.

0 commit comments

Comments
 (0)