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

#include <ImageFrameBlob.h>

Inherits openjaus::model::fields::Blob.

Public Types

enum  {
  JPEG = 0, GIF = 1, PNG = 2, BMP = 3,
  TIFF = 4, PPM = 5, PGM = 6, PNM = 7,
  NEF = 8, CR_2 = 9, DNG = 10
}
 

Public Member Functions

 ImageFrameBlob ()
 
 ~ImageFrameBlob ()
 
void copy (ImageFrameBlob &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
 
uint8_t getFormat () const
 
std::string formatToString () const
 
bool setPayload (uint8_t format, system::Buffer &payload)
 
- Public Member Functions inherited from openjaus::model::fields::Blob
 Blob ()
 
virtual ~Blob ()
 
TypesUnsigned getSizeType () const
 Accessor to get the value of sizeType. More...
 
bool setSizeType (TypesUnsigned sizeType)
 Accessor to set value of sizeType. More...
 
const std::vector< BlobType *> & getTypes () const
 Accessor to get the value of types. More...
 
bool setTypes (const BlobType &types)
 Accessor to set value of types. More...
 
const system::BuffergetPayload () const
 Accessor to get the value of payload. More...
 
bool setPayload (const system::Buffer &payload)
 Accessor to set value of payload. 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 ()
 

Protected Attributes

uint8_t format
 
- Protected Attributes inherited from openjaus::model::fields::Blob
TypesUnsigned sizeType
 
std::vector< BlobType *> types
 
system::Buffer payload
 
- Protected Attributes inherited from openjaus::model::fields::Field
std::string name
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
JPEG 
GIF 
PNG 
BMP 
TIFF 
PPM 
PGM 
PNM 
NEF 
CR_2 
DNG 

Constructor & Destructor Documentation

◆ ImageFrameBlob()

openjaus::environment_v1_0::ImageFrameBlob::ImageFrameBlob ( )

◆ ~ImageFrameBlob()

openjaus::environment_v1_0::ImageFrameBlob::~ImageFrameBlob ( )

Member Function Documentation

◆ copy()

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

◆ formatToString()

std::string openjaus::environment_v1_0::ImageFrameBlob::formatToString ( ) const

◆ from()

uint64 openjaus::environment_v1_0::ImageFrameBlob::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::Blob.

◆ getFormat()

uint8_t openjaus::environment_v1_0::ImageFrameBlob::getFormat ( ) const

◆ length()

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

Reimplemented from openjaus::model::fields::Blob.

◆ setPayload()

bool openjaus::environment_v1_0::ImageFrameBlob::setPayload ( uint8_t  format,
system::Buffer payload 
)

◆ to()

uint64 openjaus::environment_v1_0::ImageFrameBlob::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::Blob.

◆ toXml()

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

Member Data Documentation

◆ format

uint8_t openjaus::environment_v1_0::ImageFrameBlob::format
protected

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