JAUS::ConfirmElementRequest Class Reference

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

#include <confirmelementrequest.h>

Inheritance diagram for JAUS::ConfirmElementRequest:

List of all members.

Public Member Functions
	ConfirmElementRequest (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	ConfirmElementRequest (const ConfirmElementRequest &message)
	Copy constructor.
	~ConfirmElementRequest ()
	Destructor.
Byte	SetRequestID (const Byte rid)
Byte	GetRequestID () 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.
ConfirmElementRequest &	operator= (const ConfirmElementRequest &message)
	Sets equal to.
Protected Attributes
Byte	mRequestID
	ID of request to be confirmed.

---

Detailed Description

This message is used to confirm successful operation on an element list.

Definition at line 55 of file confirmelementrequest.h.

---

Constructor & Destructor Documentation

ConfirmElementRequest::ConfirmElementRequest	(	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 confirmelementrequest.cpp.

ConfirmElementRequest::ConfirmElementRequest

(

const ConfirmElementRequest &

message )

Copy constructor.

Definition at line 63 of file confirmelementrequest.cpp.

ConfirmElementRequest::~ConfirmElementRequest

(

)

Destructor.

Definition at line 75 of file confirmelementrequest.cpp.

---

Member Function Documentation

void ConfirmElementRequest::ClearMessageBody

(

)

[virtual]

Clears message contents.

Implements JAUS::Message.

Definition at line 129 of file confirmelementrequest.cpp.

virtual Message* JAUS::ConfirmElementRequest::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 66 of file confirmelementrequest.h.

virtual UShort JAUS::ConfirmElementRequest::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 70 of file confirmelementrequest.h.

virtual std::string JAUS::ConfirmElementRequest::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 71 of file confirmelementrequest.h.

virtual UInt JAUS::ConfirmElementRequest::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 67 of file confirmelementrequest.h.

virtual UInt JAUS::ConfirmElementRequest::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 69 of file confirmelementrequest.h.

virtual UInt JAUS::ConfirmElementRequest::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 68 of file confirmelementrequest.h.

Byte JAUS::ConfirmElementRequest::GetRequestID

(

)

const [inline]

Definition at line 62 of file confirmelementrequest.h.

virtual bool JAUS::ConfirmElementRequest::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 63 of file confirmelementrequest.h.

virtual bool JAUS::ConfirmElementRequest::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 73 of file confirmelementrequest.h.

ConfirmElementRequest & ConfirmElementRequest::operator=

(

const ConfirmElementRequest &

message )

Sets equal to.

Definition at line 170 of file confirmelementrequest.cpp.

int ConfirmElementRequest::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 113 of file confirmelementrequest.cpp.

int ConfirmElementRequest::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 142 of file confirmelementrequest.cpp.

Byte JAUS::ConfirmElementRequest::SetRequestID

(

const Byte

rid )

[inline]

Definition at line 61 of file confirmelementrequest.h.

int ConfirmElementRequest::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 91 of file confirmelementrequest.cpp.

---

Member Data Documentation

Byte JAUS::ConfirmElementRequest::mRequestID [protected]

ID of request to be confirmed.

Definition at line 77 of file confirmelementrequest.h.

---

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

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