 |
VRS
A file format for sensor data.
|
Loading...
Searching...
No Matches
|
VRS
A file format for sensor data.
|
Class designed to receive record data when reading a VRS file. More...
#include <StreamPlayer.h>
Public Member Functions | |
| virtual void | onAttachedToFileReader (RecordFileReader &, StreamId) |
| virtual bool | processRecordHeader (const CurrentRecord &record, DataReference &outDataReference) |
| virtual void | processRecord (const CurrentRecord &record, uint32_t readSize) |
| virtual bool | processStateHeader (const CurrentRecord &, DataReference &) |
| virtual void | processState (const CurrentRecord &, uint32_t) |
| virtual bool | processConfigurationHeader (const CurrentRecord &, DataReference &) |
| virtual void | processConfiguration (const CurrentRecord &, uint32_t) |
| virtual bool | processDataHeader (const CurrentRecord &, DataReference &) |
| virtual void | processData (const CurrentRecord &, uint32_t) |
| virtual int | recordReadComplete (RecordFileReader &, const IndexRecord::RecordInfo &) |
| virtual void | flush () |
Class designed to receive record data when reading a VRS file.
Class to handle data read from records of a VRS file, by attaching an instance to one or more streams of a RecordFileReader. This base class is the bare-bones way to read VRS records. Reading records is now probably better handled by the specialized RecordFormatStreamPlayer.
For each record, the stream player will be presented the record in a callback named processXXXHeader(), which will tell if the record should be read by returning true, in which case the callback is expected to set the provided DataReference to tell where the record's data should be read. Upon completion of the read, the matching processXXX() callback will be invoked, allowing the StreamPlayer to interpret/use the read data.
|
inlinevirtual |
A stream player might be queueing read data for asynchronous processing. This method can be called to signal that internal data/queues should be flushed, so processing can be guaranteed to be completed.
|
inlinevirtual |
Callback called just after the instance was attached to a RecordFileReader.
| RecordFileReader | The record file reader the instance was attached to. |
| StreamId | Stream the instance was attached to. |
Reimplemented in vrs::RecordFormatStreamPlayer.
|
inlinevirtual |
Called after processConfigurationHeader() set the DataReference it was given and returned true, and after data was written to memory specified by the DataReference.
| record | Details about the record being read. |
| bytesWrittenCount | Number of bytes read and written to the DataReference. |
|
inlinevirtual |
Called when a Configuration record is about to be read.
| record | Details about the record being read. |
| outDataReference | Reference to be set, so as to tell where data should be read. |
|
inlinevirtual |
Called after processDataHeader() set the DataReference it was given and returned true, and after data was written to memory specified by the DataReference.
| record | Details about the record being read. |
| bytesWrittenCount | Number of bytes read and written to the DataReference. |
|
inlinevirtual |
Called when a data record is about to be read.
| record | Details about the record being read. |
| outDataReference | Reference to be set, so as to tell where data should be read. |
|
inlinevirtual |
Called after processRecordHeader() set the DataReference it was given and returned true, and after data was written to memory specified by the DataReference.
| record | Details about the record being read. |
| bytesWrittenCount | Number of bytes read and written to the DataReference. The default implementation delegates to the specialized callbacks below. |
Reimplemented in vrs::RecordFormatStreamPlayer.
|
inlinevirtual |
Callback called when a record of any type is about to be read.
The default implementation delegates to the specialized callbacks below.
| record | Details about the record being read. |
| outDataReference | Reference to be set, so as to tell where data should be read. |
Reimplemented in vrs::RecordFormatStreamPlayer.
|
inlinevirtual |
Called after processStateHeader() set the DataReference it was given and returned true, and after data was written to memory specified by the DataReference.
| record | Details about the record being read. |
| bytesWrittenCount | Number of bytes read and written to the DataReference. |
|
inlinevirtual |
Called when a State record is about to be read.
| record | Details about the record being read. |
| outDataReference | Reference to be set, so as to tell where data should be read. |
|
inlinevirtual |
Called after a record was read, so maybe a follow-up action can be performed.
| reader | the VRS file reader used to read the file. |
| recordInfo | the record that was just read. |
1.9.8