openjaus::core::CancelEvent Class Reference

CancelEvent Message Implementation. More...

#include <CancelEvent.h>

Inherits openjaus::model::Message.

List of all members.

Public Member Functions
	CancelEvent ()
	CancelEvent (model::Message *message)
	~CancelEvent ()
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.
int8_t	getRequestID (void)
void	setRequestID (int8_t value)
int8_t	getEventID (void)
void	setEventID (int8_t value)
Static Public Attributes
static const uint16_t	ID = 0x01F2
Private Attributes
model::fields::Byte	requestID
model::fields::Byte	eventID

---

Detailed Description

The Cancel Event message is used by the requester to cancel and/or request deletion of the specified event.

---

Constructor & Destructor Documentation

openjaus::core::CancelEvent::CancelEvent

(

)

openjaus::core::CancelEvent::CancelEvent

(

model::Message *

message

)

openjaus::core::CancelEvent::~CancelEvent

(

)

---

Member Function Documentation

int openjaus::core::CancelEvent::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.

int8_t openjaus::core::CancelEvent::getEventID

(

void

)

int8_t openjaus::core::CancelEvent::getRequestID

(

void

)

int openjaus::core::CancelEvent::length

(

void

)

[virtual]

The number of bytes this message would occupy in a buffer

Reimplemented from openjaus::model::Message.

void openjaus::core::CancelEvent::setEventID

(

int8_t

value

)

void openjaus::core::CancelEvent::setRequestID

(

int8_t

value

)

int openjaus::core::CancelEvent::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::core::CancelEvent::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::Byte openjaus::core::CancelEvent::eventID [private]

const uint16_t openjaus::core::CancelEvent::ID = 0x01F2 [static]

model::fields::Byte openjaus::core::CancelEvent::requestID [private]

---

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

• include/openjaus/core/Triggers/CancelEvent.h
• src/openjaus/core/Triggers/CancelEvent.cpp