JAUS::CancelEvent Class Reference

This message is used to cancel a event. More...

#include <cancelevent.h>

Inheritance diagram for JAUS::CancelEvent:

List of all members.

Public Member Functions
	CancelEvent (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	CancelEvent (const CancelEvent &message)
	Copy constructor.
	~CancelEvent ()
	Destructor.
Byte	GetRequestID () const
Byte	GetEventID () const
Byte	SetRequestID (const Byte id)
Byte	SetEventID (const Byte id)
virtual bool	IsCommand () const
virtual bool	IsResponseToMessage (const Message *requestingMessage) const
	Method used to verify if this Message is a response to a requesting Query or Command message.
virtual int	WriteMessageBody (Packet &packet) const
	Writes message payload to the packet.
virtual int	ReadMessageBody (const Packet &packet)
	Reads message payload from the packet.
virtual Message *	Clone () const
virtual UInt	GetPresenceVector () const
virtual UInt	GetPresenceVectorSize () const
virtual UInt	GetPresenceVectorMask () const
virtual UShort	GetMessageCodeOfResponse () const
virtual std::string	GetMessageName () const
virtual void	ClearMessageBody ()
	Clears message payload data.
virtual bool	IsLargeDataSet (const unsigned int maxPayloadSize) const
CancelEvent &	operator= (const CancelEvent &message)
	Sets equal to.
Protected Attributes
Byte	mRequestID
	Local request ID.
Byte	mEventID
	ID of event to cancel.

---

Detailed Description

This message is used to cancel a event.

Definition at line 54 of file cancelevent.h.

---

Constructor & Destructor Documentation

CancelEvent::CancelEvent	(	const Address &	dest = Address(),
		const Address &	src = Address()
	)

Constructor, initializes default values.

Parameters:

[in]	src	Source ID of message sender.
[in]	dest	Destination ID of message.

Definition at line 54 of file cancelevent.cpp.

CancelEvent::CancelEvent

(

const CancelEvent &

message )

Copy constructor.

Definition at line 66 of file cancelevent.cpp.

CancelEvent::~CancelEvent

(

)

Destructor.

Definition at line 78 of file cancelevent.cpp.

---

Member Function Documentation

void CancelEvent::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 173 of file cancelevent.cpp.

virtual Message* JAUS::CancelEvent::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 68 of file cancelevent.h.

Byte JAUS::CancelEvent::GetEventID

(

)

const [inline]

Definition at line 61 of file cancelevent.h.

virtual UShort JAUS::CancelEvent::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 72 of file cancelevent.h.

virtual std::string JAUS::CancelEvent::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 73 of file cancelevent.h.

virtual UInt JAUS::CancelEvent::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 69 of file cancelevent.h.

virtual UInt JAUS::CancelEvent::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 71 of file cancelevent.h.

virtual UInt JAUS::CancelEvent::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 70 of file cancelevent.h.

Byte JAUS::CancelEvent::GetRequestID

(

)

const [inline]

Definition at line 60 of file cancelevent.h.

virtual bool JAUS::CancelEvent::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 64 of file cancelevent.h.

virtual bool JAUS::CancelEvent::IsLargeDataSet

(

const unsigned int

maxPayloadSize )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 75 of file cancelevent.h.

bool CancelEvent::IsResponseToMessage

(

const Message *

requestingMessage )

const [virtual]

Method used to verify if this Message is a response to a requesting Query or Command message.

This method verifies that the destination ID of the requestingMessage matches the source ID of this message and that the result of GetMessageCodeOfResponse for the requestingMessage matchings the message code of this method. Overload this method to check other parameters.

Parameters:

[in]

requestingMessage

Original query or command message that you want to see if this message is a response to.

Returns:

True if this message is a response, otherwise false.

Reimplemented from JAUS::Message.

Definition at line 102 of file cancelevent.cpp.

CancelEvent & CancelEvent::operator=

(

const CancelEvent &

message )

Sets equal to.

Definition at line 184 of file cancelevent.cpp.

int CancelEvent::ReadMessageBody

(

const Packet &

packet )

[virtual]

Reads message payload from the packet.

Message contents are read from the packet following the JAUS standard.

Parameters:

[in]

packet

Packet containing message payload data to read.

Returns:

-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 158 of file cancelevent.cpp.

Byte JAUS::CancelEvent::SetEventID

(

const Byte

id )

[inline]

Definition at line 63 of file cancelevent.h.

Byte JAUS::CancelEvent::SetRequestID

(

const Byte

id )

[inline]

Definition at line 62 of file cancelevent.h.

int CancelEvent::WriteMessageBody

(

Packet &

packet )

const [virtual]

Writes message payload to the packet.

Message contents are written to the packet following the JAUS standard.

Parameters:

[out]

packet

Packet to write payload to.

Returns:

-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 137 of file cancelevent.cpp.

---

Member Data Documentation

Byte JAUS::CancelEvent::mEventID [protected]

ID of event to cancel.

Definition at line 79 of file cancelevent.h.

Byte JAUS::CancelEvent::mRequestID [protected]

Local request ID.

Definition at line 78 of file cancelevent.h.

---

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

• jaus++/2.0/include/jaus/core/events/cancelevent.h
• jaus++/2.0/src/jaus/core/events/cancelevent.cpp