vrs_sample_code::MyCameraRecordable Class Reference

Class to generate a stream of sample records. More...

Inheritance diagram for vrs_sample_code::MyCameraRecordable:

Public Member Functions
const Record *	createConfigurationRecord () override
const Record *	createStateRecord () override
void	createDataRecords (const uint8_t *pixelData)
Public Member Functions inherited from vrs::Recordable
string	getRecordableName () const
RecordableTypeId	getRecordableTypeId () const
uint16_t	getRecordableInstanceId () const
StreamId	getStreamId () const
void	setRecordableIsActive (bool isActive)
bool	isRecordableActive () const
void	setCompression (CompressionPreset preset)
bool	addRecordFormat (Record::Type recordType, uint32_t formatVersion, const RecordFormat &format, const vector< const DataLayout * > &layouts={})
void	setCreateRecordDelegate (CreateRecordDelegate delegate)
void	setTag (const string &tagName, const string &tagValue)
void	addTags (const map< string, string > &newTags)
void	addTags (const StreamTags &tags)
const map< string, string > &	getTags () const
const StreamTags &	getStreamTags () const
const string &	getSerialNumber () const
RecordManager &	getRecordManager ()

Additional Inherited Members
Public Types inherited from vrs::Recordable
using	CreateRecordDelegate = std::function< const Record *(StreamId streamId, double timestamp, Record::Type recordType, uint32_t recordFormatVersion, const DataSource &data)>
Static Public Member Functions inherited from vrs::Recordable
static const string &	getOriginalNameTagName ()
static const string &	getFlavorTagName ()
static const string &	getSerialNumberTagName ()
	Get the name of the VRS tag used to store the stream's serial number.
static void	resetNewInstanceIds ()
Protected Member Functions inherited from vrs::Recordable
	Recordable (RecordableTypeId typeId, const string &flavor={})
const Record *	createRecord (double timestampSec, Record::Type recordType, uint32_t formatVersion, const DataSource &data=DataSource())
const Record *	createUncompressedRecord (double timestampSec, Record::Type recordType, uint32_t formatVersion, const DataSource &data, std::unique_ptr< DirectWriteRecordData > &&directWriteRecordData)
map< string, string > &	getVRSTags ()
	When direct edits of VRS tags is convenient (record filters)

Detailed Description

Class to generate a stream of sample records.

Member Function Documentation

createConfigurationRecord()

const Record * vrs_sample_code::MyCameraRecordable::createConfigurationRecord ( )

inlineoverridevirtual

Configuration records describe how the device recorded is configured/setup. The configuration of a recordable is probably not changed by data flowing through. A framerate, a resolution, are probably part of the configuration. An exposure setting as well, unless it is automatically adjusted as data flows through. The RecordFileWriter will call this method to make sure a configuration record is captured, when a record file is created asynchronously.

Implements vrs::Recordable.

createStateRecord()

const Record * vrs_sample_code::MyCameraRecordable::createStateRecord ( )

inlineoverridevirtual

State records describe the internal state of the device, if it's stateful. It is probably the result of previous calculation/processing of data.

State records should not to be confused with the configuration of the device. A position tracking algorithm probably has a state: the last position it determined, which will be used to calculate the next state when the next data come in. State data typically changes as data flows, according to that data. A camera probably has no state, but probably has a configuration. The RecordFileWriter will call this method to make sure a configuration record is captured, when a record file is created asynchronously.

Implements vrs::Recordable.

---

The documentation for this class was generated from the following file:

• sample_code/SampleRecordFormatDataLayout.cpp