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_v1_0::CompressedDataBlob, openjaus::environment_v1_0::ImageFrameBlob, and openjaus::mobility_v1_0::ElementDataBlob.

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 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 () const
	Gets the serialized length of this object. 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
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()

uint64 openjaus::model::fields::Blob::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

Implements openjaus::system::Transportable.

Reimplemented in openjaus::environment_v1_0::CompressedDataBlob, openjaus::environment_v1_0::ImageFrameBlob, and openjaus::mobility_v1_0::ElementDataBlob.

◆ 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()

uint64 openjaus::model::fields::Blob::length ( ) const

virtual

Implements openjaus::system::Transportable.

Reimplemented in openjaus::environment_v1_0::CompressedDataBlob, openjaus::environment_v1_0::ImageFrameBlob, and openjaus::mobility_v1_0::ElementDataBlob.

◆ 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()

uint64 openjaus::model::fields::Blob::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

Implements openjaus::system::Transportable.

Reimplemented in openjaus::environment_v1_0::CompressedDataBlob, openjaus::environment_v1_0::ImageFrameBlob, and openjaus::mobility_v1_0::ElementDataBlob.

◆ 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

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Blob()

◆ ~Blob()

Member Function Documentation

◆ from()

◆ getPayload()

◆ getSizeType()

◆ getTypes()

◆ length()

◆ setPayload()

◆ setSizeType()

◆ setTypes()

◆ to()

◆ toString()

Friends And Related Function Documentation

◆ operator<< [1/2]

◆ operator<< [2/2]

Member Data Documentation

◆ payload

◆ sizeType

◆ types