LibMultiSense
LibMultiSense Documentation
crl::multisense::secondary_app::Header Class Reference

Class containing Header information for a secondary_app callback. More...

#include <MultiSenseTypes.hh>

Inheritance diagram for crl::multisense::secondary_app::Header:
Collaboration diagram for crl::multisense::secondary_app::Header:

Public Member Functions

 Header ()
 Default Constructor. More...
 
- Public Member Functions inherited from crl::multisense::HeaderBase
virtual bool inMask (DataSource mask)
 This default implementation of the inMask member function will be overridden by derived classes. More...
 
virtual ~HeaderBase ()
 

Public Attributes

DataSource source
 DataSource corresponding to secondaryAppDataP. More...
 
int64_t frameId
 Unique ID used to describe an secondaryAppData. More...
 
uint32_t timeSeconds
 The time seconds value corresponding to when the secondaryAppData was captured. More...
 
uint32_t timeMicroSeconds
 The time microseconds value corresponding to when the secondaryAppData was captured. More...
 
float framesPerSecond
 The number of frames per second currently streaming from the device. More...
 
uint32_t secondaryAppDataLength
 The length of the secondaryAppData data stored in secondaryAppDataDataP. More...
 
const void * secondaryAppDataP
 A pointer to the secondaryAppData data. More...
 
uint32_t secondaryAppMetadataLength
 The metadata length. More...
 
const void * secondaryAppMetadataP
 The metadata generic payload. More...
 

Detailed Description

Class containing Header information for a secondary_app callback.

See crl::multisense::Channel::addIsolatedCallback

Definition at line 3028 of file MultiSenseTypes.hh.

Constructor & Destructor Documentation

◆ Header()

crl::multisense::secondary_app::Header::Header ( )
inline

Default Constructor.

Definition at line 3053 of file MultiSenseTypes.hh.

Member Data Documentation

◆ frameId

int64_t crl::multisense::secondary_app::Header::frameId

Unique ID used to describe an secondaryAppData.

FrameIds increase sequentally from the device

Definition at line 3034 of file MultiSenseTypes.hh.

◆ framesPerSecond

float crl::multisense::secondary_app::Header::framesPerSecond

The number of frames per second currently streaming from the device.

Definition at line 3040 of file MultiSenseTypes.hh.

◆ secondaryAppDataLength

uint32_t crl::multisense::secondary_app::Header::secondaryAppDataLength

The length of the secondaryAppData data stored in secondaryAppDataDataP.

Definition at line 3042 of file MultiSenseTypes.hh.

◆ secondaryAppDataP

const void* crl::multisense::secondary_app::Header::secondaryAppDataP

A pointer to the secondaryAppData data.

Definition at line 3044 of file MultiSenseTypes.hh.

◆ secondaryAppMetadataLength

uint32_t crl::multisense::secondary_app::Header::secondaryAppMetadataLength

The metadata length.

Definition at line 3046 of file MultiSenseTypes.hh.

◆ secondaryAppMetadataP

const void* crl::multisense::secondary_app::Header::secondaryAppMetadataP

The metadata generic payload.

Definition at line 3048 of file MultiSenseTypes.hh.

◆ source

DataSource crl::multisense::secondary_app::Header::source

DataSource corresponding to secondaryAppDataP.

Definition at line 3032 of file MultiSenseTypes.hh.

◆ timeMicroSeconds

uint32_t crl::multisense::secondary_app::Header::timeMicroSeconds

The time microseconds value corresponding to when the secondaryAppData was captured.

Definition at line 3038 of file MultiSenseTypes.hh.

◆ timeSeconds

uint32_t crl::multisense::secondary_app::Header::timeSeconds

The time seconds value corresponding to when the secondaryAppData was captured.

Definition at line 3036 of file MultiSenseTypes.hh.


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