openjaus::model::fields::MessageField Class Reference

#include <MessageField.h>

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

Public Member Functions
	MessageField ()
virtual	~MessageField ()
model::Message *	getMessage () const
	Accessor to get the value of message. More...
bool	setMessage (model::Message *message)
	Accessor to set value of message. More...
const system::Buffer &	getBuffer () const
	Accessor to get the value of buffer. More...
bool	setBuffer (const system::Buffer &buffer)
	Accessor to set value of buffer. 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
std::string	toXml (unsigned char level=0) const
void	copy (model::Message *source)
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
model::Message *	message
system::Buffer	buffer
Protected Attributes inherited from openjaus::model::fields::Field
std::string	name

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

Constructor & Destructor Documentation

MessageField()

openjaus::model::fields::MessageField::MessageField

(

)

~MessageField()

openjaus::model::fields::MessageField::~MessageField ( )

virtual

Member Function Documentation

copy()

void openjaus::model::fields::MessageField::copy

(

model::Message *

source

)

from()

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

virtual

Parameters

src

Implements openjaus::system::Transportable.

getBuffer()

const system::Buffer & openjaus::model::fields::MessageField::getBuffer

(

)

const

getMessage()

model::Message * openjaus::model::fields::MessageField::getMessage

(

)

const

length()

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

virtual

Implements openjaus::system::Transportable.

setBuffer()

bool openjaus::model::fields::MessageField::setBuffer

(

const system::Buffer &

buffer

)

Parameters

buffer

The value of the new buffer.

setMessage()

bool openjaus::model::fields::MessageField::setMessage

(

model::Message *

message

)

Parameters

message

The value of the new message.

to()

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

virtual

Parameters

dst

Implements openjaus::system::Transportable.

toString()

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

virtual

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

toXml()

std::string openjaus::model::fields::MessageField::toXml

(

unsigned char

level = 0

)

const

Friends And Related Function Documentation

operator<< [1/2]

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

friend

operator<< [2/2]

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

friend

Member Data Documentation

buffer

system::Buffer openjaus::model::fields::MessageField::buffer

protected

message

model::Message* openjaus::model::fields::MessageField::message

protected

---

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

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