JAUS::QueryActiveElement Class Reference

This message is used to query the current active element of an executing list. More...

#include <queryactiveelement.h>

Inheritance diagram for JAUS::QueryActiveElement:

List of all members.

Public Member Functions
	QueryActiveElement (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	QueryActiveElement (const QueryActiveElement &message)
	Copy constructor.
	~QueryActiveElement ()
	Destructor.
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.
QueryActiveElement &	operator= (const QueryActiveElement &message)
	Sets equal to.

---

Detailed Description

This message is used to query the current active element of an executing list.

Definition at line 55 of file queryactiveelement.h.

---

Constructor & Destructor Documentation

QueryActiveElement::QueryActiveElement	(	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 queryactiveelement.cpp.

QueryActiveElement::QueryActiveElement

(

const QueryActiveElement &

message )

Copy constructor.

Definition at line 62 of file queryactiveelement.cpp.

QueryActiveElement::~QueryActiveElement

(

)

Destructor.

Definition at line 73 of file queryactiveelement.cpp.

---

Member Function Documentation

void QueryActiveElement::ClearMessageBody

(

)

[virtual]

Clears message contents.

Implements JAUS::Message.

Definition at line 117 of file queryactiveelement.cpp.

virtual Message* JAUS::QueryActiveElement::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 64 of file queryactiveelement.h.

virtual UShort JAUS::QueryActiveElement::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 68 of file queryactiveelement.h.

virtual std::string JAUS::QueryActiveElement::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 69 of file queryactiveelement.h.

virtual UInt JAUS::QueryActiveElement::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 65 of file queryactiveelement.h.

virtual UInt JAUS::QueryActiveElement::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 67 of file queryactiveelement.h.

virtual UInt JAUS::QueryActiveElement::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 66 of file queryactiveelement.h.

virtual bool JAUS::QueryActiveElement::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 61 of file queryactiveelement.h.

virtual bool JAUS::QueryActiveElement::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 71 of file queryactiveelement.h.

QueryActiveElement & QueryActiveElement::operator=

(

const QueryActiveElement &

message )

Sets equal to.

Definition at line 152 of file queryactiveelement.cpp.

int QueryActiveElement::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 106 of file queryactiveelement.cpp.

int QueryActiveElement::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 129 of file queryactiveelement.cpp.

int QueryActiveElement::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 89 of file queryactiveelement.cpp.

---

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

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