openjaus::mobility::ReportActiveElement Class Reference

ReportActiveElement Message Implementation. More...

#include <ReportActiveElement.h>

Inherits openjaus::model::Message.

List of all members.

Public Member Functions
	ReportActiveElement ()
	ReportActiveElement (model::Message *message)
	~ReportActiveElement ()
virtual int	to (system::Buffer *dst)
	Pack this message to the given openjaus::system::Buffer.
virtual int	from (system::Buffer *src)
	Unpack this message from the given openjaus::system::Buffer.
virtual int	length ()
	Get the number of bytes this message would occupy in a serialized buffer.
std::string	toXml (unsigned char level=0) const
	Used to serialize the runtime state of the message to an XML format.
uint16_t	getElementUID (void)
void	setElementUID (uint16_t value)
Static Public Attributes
static const uint16_t	ID = 0x441E
Private Attributes
model::fields::UnsignedShort	elementUID

---

Detailed Description

This message is used to report the identifier of the current list element being executed.

---

Constructor & Destructor Documentation

openjaus::mobility::ReportActiveElement::ReportActiveElement

(

)

openjaus::mobility::ReportActiveElement::ReportActiveElement

(

model::Message *

message

)

openjaus::mobility::ReportActiveElement::~ReportActiveElement

(

)

---

Member Function Documentation

int openjaus::mobility::ReportActiveElement::from

(

system::Buffer *

src

)

[virtual]

src - The source openjaus::system::Buffer from which this message will be unpacked.

Returns:

The number of bytes unpacked from the source buffer

Reimplemented from openjaus::model::Message.

uint16_t openjaus::mobility::ReportActiveElement::getElementUID

(

void

)

int openjaus::mobility::ReportActiveElement::length

(

void

)

[virtual]

The number of bytes this message would occupy in a buffer

Reimplemented from openjaus::model::Message.

void openjaus::mobility::ReportActiveElement::setElementUID

(

uint16_t

value

)

int openjaus::mobility::ReportActiveElement::to

(

system::Buffer *

dst

)

[virtual]

dst - The destination openjaus::system::Buffer to which this message will be packed.

Returns:

The number of bytes packed into the destination buffer

Reimplemented from openjaus::model::Message.

std::string openjaus::mobility::ReportActiveElement::toXml

(

unsigned char

level = 0

)

const

level - Used to determine how many tabs are inserted per line for pretty formating.

Returns:

The serialized XML string

---

Member Data Documentation

model::fields::UnsignedShort openjaus::mobility::ReportActiveElement::elementUID [private]

const uint16_t openjaus::mobility::ReportActiveElement::ID = 0x441E [static]

---

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

• include/openjaus/mobility/Triggers/ReportActiveElement.h
• src/openjaus/mobility/Triggers/ReportActiveElement.cpp