JAUS::DeleteElement Class Reference

This message is used to delete one or more elements from a list. Each element is uniquely identified by the UID. More...

#include <deleteelement.h>

Inheritance diagram for JAUS::DeleteElement:

List of all members.

Public Types
typedef std::vector< UShort >	List
Public Member Functions
	DeleteElement (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	DeleteElement (const DeleteElement &message)
	Copy constructor.
	~DeleteElement ()
	Destructor.
Byte	SetRequestID (const Byte rid)
Byte	GetRequestID () const
List *	GetElementList ()
const List *	GetElementList () 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.
DeleteElement &	operator= (const DeleteElement &message)
	Sets equal to.
Protected Attributes
Byte	mRequestID
	ID of request to be returned in response message.
List	mElementUIDs
	UIDs of the element to be removed (65535 represents all).

---

Detailed Description

This message is used to delete one or more elements from a list. Each element is uniquely identified by the UID.

Definition at line 55 of file deleteelement.h.

---

Member Typedef Documentation

typedef std::vector<UShort> JAUS::DeleteElement::List

Reimplemented from JAUS::Message.

Definition at line 58 of file deleteelement.h.

---

Constructor & Destructor Documentation

DeleteElement::DeleteElement	(	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 deleteelement.cpp.

DeleteElement::DeleteElement

(

const DeleteElement &

message )

Copy constructor.

Definition at line 63 of file deleteelement.cpp.

DeleteElement::~DeleteElement

(

)

Destructor.

Definition at line 75 of file deleteelement.cpp.

---

Member Function Documentation

void DeleteElement::ClearMessageBody

(

)

[virtual]

Clears message contents.

Implements JAUS::Message.

Definition at line 155 of file deleteelement.cpp.

virtual Message* JAUS::DeleteElement::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 69 of file deleteelement.h.

List* JAUS::DeleteElement::GetElementList

(

)

[inline]

Definition at line 64 of file deleteelement.h.

const List* JAUS::DeleteElement::GetElementList

(

)

const [inline]

Definition at line 65 of file deleteelement.h.

virtual UShort JAUS::DeleteElement::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 73 of file deleteelement.h.

virtual std::string JAUS::DeleteElement::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 74 of file deleteelement.h.

virtual UInt JAUS::DeleteElement::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 70 of file deleteelement.h.

virtual UInt JAUS::DeleteElement::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 72 of file deleteelement.h.

virtual UInt JAUS::DeleteElement::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 71 of file deleteelement.h.

Byte JAUS::DeleteElement::GetRequestID

(

)

const [inline]

Definition at line 63 of file deleteelement.h.

virtual bool JAUS::DeleteElement::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 66 of file deleteelement.h.

virtual bool JAUS::DeleteElement::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 76 of file deleteelement.h.

DeleteElement & DeleteElement::operator=

(

const DeleteElement &

message )

Sets equal to.

Definition at line 197 of file deleteelement.cpp.

int DeleteElement::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 124 of file deleteelement.cpp.

int DeleteElement::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 169 of file deleteelement.cpp.

Byte JAUS::DeleteElement::SetRequestID

(

const Byte

rid )

[inline]

Definition at line 62 of file deleteelement.h.

int DeleteElement::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 deleteelement.cpp.

---

Member Data Documentation

List JAUS::DeleteElement::mElementUIDs [protected]

UIDs of the element to be removed (65535 represents all).

Definition at line 81 of file deleteelement.h.

Byte JAUS::DeleteElement::mRequestID [protected]

ID of request to be returned in response message.

Definition at line 80 of file deleteelement.h.

---

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

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