JAUS::QueryEvents Class Reference

This message is used to request detail on events. Queries can be made by message ID, event type or Event ID. If no filter is specified, all events should be reported. More...

#include <queryevents.h>

Inheritance diagram for JAUS::QueryEvents:

List of all members.

Public Types
enum	Type { MessageID = 0, EventType, EventID, AllEvents }
Public Member Functions
	QueryEvents (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	QueryEvents (const QueryEvents &message)
	Copy constructor.
	~QueryEvents ()
	Destructor.
Type	GetQueryType () const
UShort	GetQueryFilter () const
void	SetQueryType (const Type queryType)
void	SetQueryFilter (const UShort filterData)
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 payload data.
virtual bool	IsLargeDataSet (const unsigned int maxPayloadSize) const
QueryEvents &	operator= (const QueryEvents &message)
	Sets equal to.
Protected Attributes
Type	mQueryType
	Query filter for requested event details.
UShort	mQueryFilter
	Variable type based on mQueryType (could be message ID, event type, etc.)

---

Detailed Description

This message is used to request detail on events. Queries can be made by message ID, event type or Event ID. If no filter is specified, all events should be reported.

Definition at line 57 of file queryevents.h.

---

Member Enumeration Documentation

enum JAUS::QueryEvents::Type

Enumerator:

MessageID
EventType
EventID
AllEvents

Definition at line 61 of file queryevents.h.

---

Constructor & Destructor Documentation

QueryEvents::QueryEvents	(	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 queryevents.cpp.

QueryEvents::QueryEvents

(

const QueryEvents &

message )

Copy constructor.

Definition at line 65 of file queryevents.cpp.

QueryEvents::~QueryEvents

(

)

Destructor.

Definition at line 78 of file queryevents.cpp.

---

Member Function Documentation

void QueryEvents::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 161 of file queryevents.cpp.

virtual Message* JAUS::QueryEvents::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 78 of file queryevents.h.

virtual UShort JAUS::QueryEvents::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 82 of file queryevents.h.

virtual std::string JAUS::QueryEvents::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 83 of file queryevents.h.

virtual UInt JAUS::QueryEvents::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 79 of file queryevents.h.

virtual UInt JAUS::QueryEvents::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 81 of file queryevents.h.

virtual UInt JAUS::QueryEvents::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 80 of file queryevents.h.

UShort JAUS::QueryEvents::GetQueryFilter

(

)

const [inline]

Definition at line 72 of file queryevents.h.

Type JAUS::QueryEvents::GetQueryType

(

)

const [inline]

Definition at line 71 of file queryevents.h.

virtual bool JAUS::QueryEvents::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 75 of file queryevents.h.

virtual bool JAUS::QueryEvents::IsLargeDataSet

(

const unsigned int

maxPayloadSize )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 85 of file queryevents.h.

QueryEvents & QueryEvents::operator=

(

const QueryEvents &

message )

Sets equal to.

Definition at line 173 of file queryevents.cpp.

int QueryEvents::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 129 of file queryevents.cpp.

void JAUS::QueryEvents::SetQueryFilter

(

const UShort

filterData )

[inline]

Definition at line 74 of file queryevents.h.

void JAUS::QueryEvents::SetQueryType

(

const Type

queryType )

[inline]

Definition at line 73 of file queryevents.h.

int QueryEvents::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 95 of file queryevents.cpp.

---

Member Data Documentation

UShort JAUS::QueryEvents::mQueryFilter [protected]

Variable type based on mQueryType (could be message ID, event type, etc.)

Definition at line 89 of file queryevents.h.

Type JAUS::QueryEvents::mQueryType [protected]

Query filter for requested event details.

Definition at line 88 of file queryevents.h.

---

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

• jaus++/2.0/include/jaus/core/events/queryevents.h
• jaus++/2.0/src/jaus/core/events/queryevents.cpp