Skip to content

docs: deprecate SensorDataSeries and SensorDataSeriesList for removal in v4.0.0 #901

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jdsika wants to merge 1 commit into
base: master
Choose a base branch
from
+13 −2
Open

docs: deprecate SensorDataSeries and SensorDataSeriesList for removal in v4.0.0 #901

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions osi_datarecording.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,14 @@ import "osi_sensordata.proto";
package osi3;

//
// \brief (Time) Series of \c SensorData messages that may be used for data
// recording or internal buffering by some sensor models.
// \brief (Time) Series of \c SensorData messages.
//
// \attention DEPRECATED: This message will be removed in OSI 4.0.0.
// Use the OSI trace file formats instead, which generalize
// the concept to any top-level message type and support streaming
// without requiring all time steps to be held in memory at once.
// Internal buffering by sensor models should be handled within the
// sensor model implementation.
//
message SensorDataSeries
{
Expand All @@ -21,6 +27,11 @@ message SensorDataSeries
// \brief List of sensors where each element contains a time series of
// \c SensorData messages.
//
// \attention DEPRECATED: This message will be removed in OSI 4.0.0.
// Use the OSI trace file formats instead, which generalize
// the concept to any combination of top-level message types and
// provide metadata, schema records, compression, and random access.
//
message SensorDataSeriesList
{
// List of sensor data for multiple sensors at subsequent time steps.
Expand Down
Loading