OpenJAUS SAE SDK  6.0.0
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
openjaus::environment_v1_0::StillImageDataRecord Class Reference

#include <StillImageDataRecord.h>

Inherits openjaus::model::fields::Record.

Public Member Functions

 StillImageDataRecord ()
 
 StillImageDataRecord (const StillImageDataRecord &source)
 
 ~StillImageDataRecord ()
 
void copy (StillImageDataRecord &source)
 
virtual uint64 to (system::BufferWriter &dst) const
 Serializes the contents of this object into the Buffer connected to the provided BufferWriter. More...
 
virtual uint64 from (system::BufferReader &src)
 Deserializes the contents the Buffer connected to the provided BufferReader into this object. More...
 
virtual uint64 length (void) const
 Gets the serialized length of this object. More...
 
std::string toXml (unsigned char ojIndentLevel=0) const
 
void setPresenceVector (uint8_t value)
 
uint8_t getPresenceVector (void) const
 
bool isTimeStampEnabled (void) const
 
void enableTimeStamp (void)
 
void disableTimeStamp (void)
 
uint16_t getSensorID (void)
 
bool setSensorID (uint16_t value)
 
ReportCoordinateSystemRefEnumeration::ReportCoordinateSystemRefEnum getReportCoordinateSystem (void)
 
bool setReportCoordinateSystem (ReportCoordinateSystemRefEnumeration::ReportCoordinateSystemRefEnum value)
 
std::string getReportCoordinateSystemToString (void)
 
model::fields::TimeStampgetTimeStamp (void)
 
ImageFrameBlobgetImageFrame (void)
 
- Public Member Functions inherited from openjaus::model::fields::Record
 Record ()
 
virtual ~Record ()
 
const std::vector< Field *> & getFields () const
 Accessor to get the value of fields. More...
 
bool setFields (const Field &fields)
 Accessor to set value of fields. More...
 
virtual std::string toString () const
 
- Public Member Functions inherited from openjaus::model::fields::ComplexField
virtual ~ComplexField ()
 
- Public Member Functions inherited from openjaus::model::fields::Field
 Field ()
 
virtual ~Field ()
 
std::string getName () const
 Accessor to get the value of name. More...
 
bool setName (std::string name)
 Accessor to set value of name. More...
 
- Public Member Functions inherited from openjaus::system::Transportable
 Transportable ()
 
virtual ~Transportable ()
 

Static Public Attributes

static const uint8_t PV_NO_FIELDS = 0x0
 
static const uint8_t PV_TIMESTAMP = 0x1
 
static const uint8_t PV_ALL_FIELDS = PV_NO_FIELDS | PV_TIMESTAMP
 

Protected Attributes

model::fields::UnsignedShort sensorID
 
ReportCoordinateSystemRefEnumeration reportCoordinateSystem
 
model::fields::TimeStamp timeStamp
 
ImageFrameBlob imageFrame
 
uint8_t presenceVector
 
- Protected Attributes inherited from openjaus::model::fields::Record
std::vector< Field *> fields
 
- Protected Attributes inherited from openjaus::model::fields::Field
std::string name
 

Constructor & Destructor Documentation

◆ StillImageDataRecord() [1/2]

openjaus::environment_v1_0::StillImageDataRecord::StillImageDataRecord ( )

◆ StillImageDataRecord() [2/2]

openjaus::environment_v1_0::StillImageDataRecord::StillImageDataRecord ( const StillImageDataRecord source)

◆ ~StillImageDataRecord()

openjaus::environment_v1_0::StillImageDataRecord::~StillImageDataRecord ( )

Member Function Documentation

◆ copy()

void openjaus::environment_v1_0::StillImageDataRecord::copy ( StillImageDataRecord source)

◆ disableTimeStamp()

void openjaus::environment_v1_0::StillImageDataRecord::disableTimeStamp ( void  )

◆ enableTimeStamp()

void openjaus::environment_v1_0::StillImageDataRecord::enableTimeStamp ( void  )

◆ from()

uint64 openjaus::environment_v1_0::StillImageDataRecord::from ( system::BufferReader src)
virtual

Deserializes the contents the Buffer connected to the provided BufferReader into this object. The BufferReader position will be advanced inside this method such that calling from() again will attempt to read the next Transportable object from the Buffer.

Parameters
src

Reimplemented from openjaus::model::fields::Record.

◆ getImageFrame()

ImageFrameBlob & openjaus::environment_v1_0::StillImageDataRecord::getImageFrame ( void  )

◆ getPresenceVector()

uint8_t openjaus::environment_v1_0::StillImageDataRecord::getPresenceVector ( void  ) const

◆ getReportCoordinateSystem()

ReportCoordinateSystemRefEnumeration::ReportCoordinateSystemRefEnum openjaus::environment_v1_0::StillImageDataRecord::getReportCoordinateSystem ( void  )

◆ getReportCoordinateSystemToString()

std::string openjaus::environment_v1_0::StillImageDataRecord::getReportCoordinateSystemToString ( void  )

◆ getSensorID()

uint16_t openjaus::environment_v1_0::StillImageDataRecord::getSensorID ( void  )

◆ getTimeStamp()

model::fields::TimeStamp & openjaus::environment_v1_0::StillImageDataRecord::getTimeStamp ( void  )

◆ isTimeStampEnabled()

bool openjaus::environment_v1_0::StillImageDataRecord::isTimeStampEnabled ( void  ) const

◆ length()

uint64 openjaus::environment_v1_0::StillImageDataRecord::length ( void  ) const
virtual

Reimplemented from openjaus::model::fields::Record.

◆ setPresenceVector()

void openjaus::environment_v1_0::StillImageDataRecord::setPresenceVector ( uint8_t  value)

◆ setReportCoordinateSystem()

bool openjaus::environment_v1_0::StillImageDataRecord::setReportCoordinateSystem ( ReportCoordinateSystemRefEnumeration::ReportCoordinateSystemRefEnum  value)

◆ setSensorID()

bool openjaus::environment_v1_0::StillImageDataRecord::setSensorID ( uint16_t  value)

◆ to()

uint64 openjaus::environment_v1_0::StillImageDataRecord::to ( system::BufferWriter dst) const
virtual

Serializes the contents of this object into the Buffer connected to the provided BufferWriter. The BufferWriter position will be advanced inside this method such that calling to() again will write the Transportable object into the Buffer a second time.

Parameters
dst

Reimplemented from openjaus::model::fields::Record.

◆ toXml()

std::string openjaus::environment_v1_0::StillImageDataRecord::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

◆ imageFrame

ImageFrameBlob openjaus::environment_v1_0::StillImageDataRecord::imageFrame
protected

◆ presenceVector

uint8_t openjaus::environment_v1_0::StillImageDataRecord::presenceVector
protected

◆ PV_ALL_FIELDS

const uint8_t openjaus::environment_v1_0::StillImageDataRecord::PV_ALL_FIELDS = PV_NO_FIELDS | PV_TIMESTAMP
static

◆ PV_NO_FIELDS

const uint8_t openjaus::environment_v1_0::StillImageDataRecord::PV_NO_FIELDS = 0x0
static

◆ PV_TIMESTAMP

const uint8_t openjaus::environment_v1_0::StillImageDataRecord::PV_TIMESTAMP = 0x1
static

◆ reportCoordinateSystem

ReportCoordinateSystemRefEnumeration openjaus::environment_v1_0::StillImageDataRecord::reportCoordinateSystem
protected

◆ sensorID

model::fields::UnsignedShort openjaus::environment_v1_0::StillImageDataRecord::sensorID
protected

◆ timeStamp

model::fields::TimeStamp openjaus::environment_v1_0::StillImageDataRecord::timeStamp
protected

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