Ocean IO Serialization Library

The Ocean IO Serialization Library provides functionalities for data serialization and deserialization. More...

Collaboration diagram for Ocean IO Serialization Library:

Data Structures
class	Ocean::IO::Serialization::DataSample
	This class implements a base class for data samples. More...
class	Ocean::IO::Serialization::DataSerializer
	This class implements the base class for data serializers. More...
class	Ocean::IO::Serialization::DataTimestamp
	This class implements a data timestamp which can hold either a double or int64_t value. More...
class	Ocean::IO::Serialization::InputDataSerializer
	This class implements an input data serializer. More...
class	Ocean::IO::Serialization::FileInputDataSerializer
	This class implements a file-based input data serializer. More...
class	Ocean::IO::Serialization::MediaSerializer
	This class implements media serialization functionalities. More...
class	Ocean::IO::Serialization::OutputDataSerializer
	This class implements an output data serializer. More...
class	Ocean::IO::Serialization::FileOutputDataSerializer
	This class implements a file-based output data serializer. More...
class	Ocean::IO::Serialization::VectorOutputStream
	This class implements an output stream that writes to an internal vector buffer. More...

Typedefs
using	Ocean::IO::Serialization::UniqueDataSample = std::unique_ptr< DataSample >
	Definition of a unique pointer holding a DataSample.

Detailed Description

The Ocean IO Serialization Library provides functionalities for data serialization and deserialization.

The library supports streaming binary data with timestamps and channels for recording and playback.

The library is organized around the following core components:

• DataSerializer: The abstract base class for all serializers, defining the channel and sample management interface.
  
• OutputDataSerializer: Serializes data samples to a stream (e.g., file or network) for recording purposes.
  
• InputDataSerializer: Deserializes data samples from a stream for playback with configurable speed control.
  
• DataSample: The abstract base class for all data samples, containing timestamps for both recording and playback.
  
• DataTimestamp: A flexible timestamp class supporting both double and int64_t representations.
  
• MediaSerializer: Provides specialized data samples for media content, e.g., DataSampleFrame for Ocean::Frame objects with optional camera models.
  
• VectorOutputStream: A memory-based output stream implementation for in-memory buffering.

Typical usage involves creating an output serializer to record data samples into channels, or creating an input serializer to play back previously recorded data with timing control.

Typedef Documentation

UniqueDataSample

using Ocean::IO::Serialization::UniqueDataSample = typedef std::unique_ptr<DataSample>

Definition of a unique pointer holding a DataSample.

See also

DataSample.