openjaus::model::fields::Blob Class Reference

This is a brief description. More...

#include <Blob.h>

Inherits openjaus::model::fields::ComplexField, openjaus::model::fields::Field, and openjaus::system::Transportable.

Inherited by openjaus::environment::CompressedDataBlob, and openjaus::environment::ImageFrameBlob.

Public Member Functions
	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::Buffer &	getPayload () const
	Accessor to get the value of payload. More...
bool	setPayload (const system::Buffer &payload)
	Accessor to set value of payload. More...
virtual int	to (system::Buffer *dst)
	Operation to. More...
virtual int	from (system::Buffer *src)
	Operation from. More...
virtual int	length ()
	Serializes object to internal transport buffer. 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
virtual	~Transportable ()
	Transportable ()

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

Friends
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const Blob &object)
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const Blob *object)

Detailed Description

Detailed description.

Author

Name (name@.nosp@m.emai.nosp@m.l.com)

Constructor & Destructor Documentation

Blob()

openjaus::model::fields::Blob::Blob

(

)

~Blob()

openjaus::model::fields::Blob::~Blob ( )

virtual

Member Function Documentation

from()

int openjaus::model::fields::Blob::from ( system::Buffer *  src )

virtual

Parameters

src

Implements openjaus::system::Transportable.

Reimplemented in openjaus::environment::CompressedDataBlob, and openjaus::environment::ImageFrameBlob.

getPayload()

const system::Buffer & openjaus::model::fields::Blob::getPayload

(

)

const

getSizeType()

TypesUnsigned openjaus::model::fields::Blob::getSizeType

(

)

const

getTypes()

const std::vector< BlobType *> & openjaus::model::fields::Blob::getTypes

(

)

const

length()

int openjaus::model::fields::Blob::length ( )

virtual

Implements openjaus::system::Transportable.

Reimplemented in openjaus::environment::CompressedDataBlob, and openjaus::environment::ImageFrameBlob.

setPayload()

bool openjaus::model::fields::Blob::setPayload

(

const system::Buffer &

payload

)

Parameters

payload

The value of the new payload.

setSizeType()

bool openjaus::model::fields::Blob::setSizeType

(

TypesUnsigned

sizeType

)

Parameters

sizeType

The value of the new sizeType.

setTypes()

bool openjaus::model::fields::Blob::setTypes

(

const BlobType &

types

)

Parameters

types

The value of the new types.

to()

int openjaus::model::fields::Blob::to ( system::Buffer *  dst )

virtual

Parameters

dst

Implements openjaus::system::Transportable.

Reimplemented in openjaus::environment::CompressedDataBlob, and openjaus::environment::ImageFrameBlob.

toString()

std::string openjaus::model::fields::Blob::toString ( ) const

virtual

Reimplemented from openjaus::model::fields::Field.

Friends And Related Function Documentation

operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const Blob &  object  )

friend

operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const Blob *  object  )

friend

Member Data Documentation

payload

system::Buffer openjaus::model::fields::Blob::payload

protected

sizeType

TypesUnsigned openjaus::model::fields::Blob::sizeType

protected

types

std::vector< BlobType* > openjaus::model::fields::Blob::types

protected

---

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

• include/openjaus/model/fields/Blob.h
• src/openjaus/model/fields/Blob.cpp