JAUS::RejectElementRequest Class Reference

This message is used to reject an operation on an element list. More...

#include <rejectelementrequest.h>

Inheritance diagram for JAUS::RejectElementRequest:

List of all members.

Public Types
enum	Response {   InvalidElementID = 1, InvalidPreviousElement, InvalidNextElement, UnsupportedElementType,   ElementIDNotFound, OutOfMemory, UnspecifiedError }
Public Member Functions
	RejectElementRequest (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	RejectElementRequest (const RejectElementRequest &message)
	Copy constructor.
	~RejectElementRequest ()
	Destructor.
Byte	SetRequestID (const Byte rid)
Byte	SetResponseCode (const Response code)
Byte	GetRequestID () const
Byte	GetResponseCode () const
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 contents.
virtual bool	IsLargeDataSet (const unsigned int maxPayloadSize=1437) const
virtual int	RunTestCase () const
	Runs a test case to validate the message class.
RejectElementRequest &	operator= (const RejectElementRequest &message)
	Sets equal to.
Protected Attributes
Byte	mRequestID
	ID of request to be confirmed.
Response	mResponseCode
	Response code.

---

Detailed Description

This message is used to reject an operation on an element list.

Definition at line 54 of file rejectelementrequest.h.

---

Member Enumeration Documentation

enum JAUS::RejectElementRequest::Response

Enumerator:

InvalidElementID
InvalidPreviousElement
InvalidNextElement
UnsupportedElementType
ElementIDNotFound
OutOfMemory
UnspecifiedError

Definition at line 58 of file rejectelementrequest.h.

---

Constructor & Destructor Documentation

RejectElementRequest::RejectElementRequest	(	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 52 of file rejectelementrequest.cpp.

RejectElementRequest::RejectElementRequest

(

const RejectElementRequest &

message )

Copy constructor.

Definition at line 64 of file rejectelementrequest.cpp.

RejectElementRequest::~RejectElementRequest

(

)

Destructor.

Definition at line 77 of file rejectelementrequest.cpp.

---

Member Function Documentation

void RejectElementRequest::ClearMessageBody

(

)

[virtual]

Clears message contents.

Implements JAUS::Message.

Definition at line 133 of file rejectelementrequest.cpp.

virtual Message* JAUS::RejectElementRequest::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 78 of file rejectelementrequest.h.

virtual UShort JAUS::RejectElementRequest::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 82 of file rejectelementrequest.h.

virtual std::string JAUS::RejectElementRequest::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 83 of file rejectelementrequest.h.

virtual UInt JAUS::RejectElementRequest::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 79 of file rejectelementrequest.h.

virtual UInt JAUS::RejectElementRequest::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 81 of file rejectelementrequest.h.

virtual UInt JAUS::RejectElementRequest::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 80 of file rejectelementrequest.h.

Byte JAUS::RejectElementRequest::GetRequestID

(

)

const [inline]

Definition at line 73 of file rejectelementrequest.h.

Byte JAUS::RejectElementRequest::GetResponseCode

(

)

const [inline]

Definition at line 74 of file rejectelementrequest.h.

virtual bool JAUS::RejectElementRequest::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 75 of file rejectelementrequest.h.

virtual bool JAUS::RejectElementRequest::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 85 of file rejectelementrequest.h.

RejectElementRequest & RejectElementRequest::operator=

(

const RejectElementRequest &

message )

Sets equal to.

Definition at line 177 of file rejectelementrequest.cpp.

int RejectElementRequest::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 116 of file rejectelementrequest.cpp.

int RejectElementRequest::RunTestCase

(

)

const [virtual]

Runs a test case to validate the message class.

Returns:

1 on success, otherwise 0.

Reimplemented from JAUS::Message.

Definition at line 147 of file rejectelementrequest.cpp.

Byte JAUS::RejectElementRequest::SetRequestID

(

const Byte

rid )

[inline]

Definition at line 71 of file rejectelementrequest.h.

Byte JAUS::RejectElementRequest::SetResponseCode

(

const Response

code )

[inline]

Definition at line 72 of file rejectelementrequest.h.

int RejectElementRequest::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 93 of file rejectelementrequest.cpp.

---

Member Data Documentation

Byte JAUS::RejectElementRequest::mRequestID [protected]

ID of request to be confirmed.

Definition at line 89 of file rejectelementrequest.h.

Response JAUS::RejectElementRequest::mResponseCode [protected]

Response code.

Definition at line 90 of file rejectelementrequest.h.

---

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

• jaus++/2.0/include/jaus/mobility/list/rejectelementrequest.h
• jaus++/2.0/src/jaus/mobility/list/rejectelementrequest.cpp