JAUS::RejectEventRequest Class Reference

This message is used to reject an event request. More...

#include <rejecteventrequest.h>

Inheritance diagram for JAUS::RejectEventRequest:

List of all members.

Classes
class	PresenceVector
	This class contains bit masks for bitwise operations on the presence vector for this message. More...
Public Types
enum	Response {   NoPeriodicEvents = 0, NoEveryChangeEvents, ConnectionRefused, InvalidSetup,   MessageNotSupported, InvalidEventID }
Public Member Functions
	RejectEventRequest (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	RejectEventRequest (const RejectEventRequest &message)
	Copy constructor.
	~RejectEventRequest ()
	Destructor.
Byte	GetRequestID () const
Byte	GetResponseCode () const
std::string	GetErrorMessage () const
Byte	SetRequestID (const Byte id)
Byte	SetResponseCode (const Response code)
bool	SetErrorMessage (const std::string &message)
	Sets the rejection error message.
virtual bool	IsCommand () const
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
RejectEventRequest &	operator= (const RejectEventRequest &message)
	Sets equal to.
Protected Attributes
Byte	mPresenceVector
	Presence vector.
Byte	mRequestID
	Local request ID.
Response	mResponseCode
	Response code.
std::string	mErrorMessage
	Error message.

---

Detailed Description

This message is used to reject an event request.

Definition at line 55 of file rejecteventrequest.h.

---

Member Enumeration Documentation

enum JAUS::RejectEventRequest::Response

Enumerator:

NoPeriodicEvents
NoEveryChangeEvents
ConnectionRefused
InvalidSetup
MessageNotSupported
InvalidEventID

Definition at line 59 of file rejecteventrequest.h.

---

Constructor & Destructor Documentation

RejectEventRequest::RejectEventRequest	(	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 rejecteventrequest.cpp.

RejectEventRequest::RejectEventRequest

(

const RejectEventRequest &

message )

Copy constructor.

Definition at line 67 of file rejecteventrequest.cpp.

RejectEventRequest::~RejectEventRequest

(

)

Destructor.

Definition at line 80 of file rejecteventrequest.cpp.

---

Member Function Documentation

void RejectEventRequest::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 174 of file rejecteventrequest.cpp.

virtual Message* JAUS::RejectEventRequest::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 92 of file rejecteventrequest.h.

std::string JAUS::RejectEventRequest::GetErrorMessage

(

)

const [inline]

Definition at line 85 of file rejecteventrequest.h.

virtual UShort JAUS::RejectEventRequest::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 96 of file rejecteventrequest.h.

virtual std::string JAUS::RejectEventRequest::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 97 of file rejecteventrequest.h.

virtual UInt JAUS::RejectEventRequest::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 93 of file rejecteventrequest.h.

virtual UInt JAUS::RejectEventRequest::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 95 of file rejecteventrequest.h.

virtual UInt JAUS::RejectEventRequest::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 94 of file rejecteventrequest.h.

Byte JAUS::RejectEventRequest::GetRequestID

(

)

const [inline]

Definition at line 83 of file rejecteventrequest.h.

Byte JAUS::RejectEventRequest::GetResponseCode

(

)

const [inline]

Definition at line 84 of file rejecteventrequest.h.

virtual bool JAUS::RejectEventRequest::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 89 of file rejecteventrequest.h.

virtual bool JAUS::RejectEventRequest::IsLargeDataSet

(

const unsigned int

maxPayloadSize )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 99 of file rejecteventrequest.h.

RejectEventRequest & RejectEventRequest::operator=

(

const RejectEventRequest &

message )

Sets equal to.

Definition at line 187 of file rejecteventrequest.cpp.

int RejectEventRequest::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 150 of file rejecteventrequest.cpp.

bool RejectEventRequest::SetErrorMessage

(

const std::string &

errorMessage )

Sets the rejection error message.

Parameters:

[in]

errorMessage

Error message associated with rejection of event. Cannot be greater than 80 characters.

Returns:

True if set, false on failure.

Definition at line 96 of file rejecteventrequest.cpp.

Byte JAUS::RejectEventRequest::SetRequestID

(

const Byte

id )

[inline]

Definition at line 86 of file rejecteventrequest.h.

Byte JAUS::RejectEventRequest::SetResponseCode

(

const Response

code )

[inline]

Definition at line 87 of file rejecteventrequest.h.

int RejectEventRequest::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 120 of file rejecteventrequest.cpp.

---

Member Data Documentation

std::string JAUS::RejectEventRequest::mErrorMessage [protected]

Error message.

Definition at line 105 of file rejecteventrequest.h.

Byte JAUS::RejectEventRequest::mPresenceVector [protected]

Presence vector.

Definition at line 102 of file rejecteventrequest.h.

Byte JAUS::RejectEventRequest::mRequestID [protected]

Local request ID.

Definition at line 103 of file rejecteventrequest.h.

Response JAUS::RejectEventRequest::mResponseCode [protected]

Response code.

Definition at line 104 of file rejecteventrequest.h.

---

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

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