Skip to content

Commit 2d468fc

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 2d468fc

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

osi_datarecording.proto

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,16 @@ 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 This message is deprecated and will be removed in OSI 4.0.0.
13+
// The single-channel OSI trace file format (.osi) supersedes
14+
// this message for recording purposes. It generalizes the concept
15+
// to any top-level message type and supports streaming without
16+
// requiring all timesteps to be held in memory at once.
17+
// Internal buffering by sensor models should be handled within
18+
// the sensor model implementation, not through the interface
19+
// specification.
1220
//
1321
message SensorDataSeries
1422
{
@@ -21,6 +29,12 @@ message SensorDataSeries
2129
// \brief List of sensors where each element contains a time series of
2230
// \c SensorData messages.
2331
//
32+
// \attention This message is deprecated and will be removed in OSI 4.0.0.
33+
// The multi-channel OSI trace file format (.mcap) supersedes
34+
// this message for recording purposes. It generalizes the concept
35+
// to any combination of top-level message types and provides
36+
// metadata, schema records, compression, and random access.
37+
//
2438
message SensorDataSeriesList
2539
{
2640
// List of sensor data for multiple sensors at subsequent time steps.

0 commit comments

Comments
 (0)