JAUS::QueryElement Class Reference

This message is used to query an element from a list. Each element is uniquely identified by the UID. More...

#include <queryelement.h>

Inheritance diagram for JAUS::QueryElement:

List of all members.

Public Member Functions
	QueryElement (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	QueryElement (const QueryElement &message)
	Copy constructor.
	~QueryElement ()
	Destructor.
UShort	SetElementUID (const Byte uid)
UShort	GetElementUID () 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.
QueryElement &	operator= (const QueryElement &message)
	Sets equal to.
Protected Attributes
UShort	mElementUID
	UID of the element to be queried. A value of 0 represents the head.

---

Detailed Description

This message is used to query an element from a list. Each element is uniquely identified by the UID.

Definition at line 55 of file queryelement.h.

---

Constructor & Destructor Documentation

QueryElement::QueryElement	(	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 queryelement.cpp.

QueryElement::QueryElement

(

const QueryElement &

message )

Copy constructor.

Definition at line 63 of file queryelement.cpp.

QueryElement::~QueryElement

(

)

Destructor.

Definition at line 75 of file queryelement.cpp.

---

Member Function Documentation

void QueryElement::ClearMessageBody

(

)

[virtual]

Clears message contents.

Implements JAUS::Message.

Definition at line 129 of file queryelement.cpp.

virtual Message* JAUS::QueryElement::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 66 of file queryelement.h.

UShort JAUS::QueryElement::GetElementUID

(

)

const [inline]

Definition at line 62 of file queryelement.h.

virtual UShort JAUS::QueryElement::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 70 of file queryelement.h.

virtual std::string JAUS::QueryElement::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 71 of file queryelement.h.

virtual UInt JAUS::QueryElement::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 67 of file queryelement.h.

virtual UInt JAUS::QueryElement::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 69 of file queryelement.h.

virtual UInt JAUS::QueryElement::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 68 of file queryelement.h.

virtual bool JAUS::QueryElement::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 63 of file queryelement.h.

virtual bool JAUS::QueryElement::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 73 of file queryelement.h.

QueryElement & QueryElement::operator=

(

const QueryElement &

message )

Sets equal to.

Definition at line 170 of file queryelement.cpp.

int QueryElement::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 queryelement.cpp.

int QueryElement::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 queryelement.cpp.

UShort JAUS::QueryElement::SetElementUID

(

const Byte

uid )

[inline]

Definition at line 61 of file queryelement.h.

int QueryElement::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 queryelement.cpp.

---

Member Data Documentation

UShort JAUS::QueryElement::mElementUID [protected]

UID of the element to be queried. A value of 0 represents the head.

Definition at line 77 of file queryelement.h.

---

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

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