JAUS::ReportEvents Class Reference

This message is used to report the active event requests that match the requirements provided in the QueryEvents message. More...

#include <reportevents.h>

Inheritance diagram for JAUS::ReportEvents:

List of all members.

Classes
class	Record
	Events Record information. More...
Public Member Functions
	ReportEvents (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	ReportEvents (const ReportEvents &message)
	Copy constructor.
	~ReportEvents ()
	Destructor.
Record::List *	GetRecords ()
const Record::List *	GetRecords () 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 ()
virtual bool	IsLargeDataSet (const unsigned int maxPayloadSize) const
ReportEvents &	operator= (const ReportEvents &message)
	Sets equal to.
Protected Attributes
Record::List	mEvents
	Events being reported.

---

Detailed Description

This message is used to report the active event requests that match the requirements provided in the QueryEvents message.

Definition at line 56 of file reportevents.h.

---

Constructor & Destructor Documentation

ReportEvents::ReportEvents	(	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 104 of file reportevents.cpp.

ReportEvents::ReportEvents

(

const ReportEvents &

message )

Copy constructor.

Definition at line 115 of file reportevents.cpp.

ReportEvents::~ReportEvents

(

)

Destructor.

Definition at line 127 of file reportevents.cpp.

---

Member Function Documentation

virtual void JAUS::ReportEvents::ClearMessageBody

(

)

[inline, virtual]

Implements JAUS::Message.

Definition at line 92 of file reportevents.h.

virtual Message* JAUS::ReportEvents::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 86 of file reportevents.h.

virtual UShort JAUS::ReportEvents::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 90 of file reportevents.h.

virtual std::string JAUS::ReportEvents::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 91 of file reportevents.h.

virtual UInt JAUS::ReportEvents::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 87 of file reportevents.h.

virtual UInt JAUS::ReportEvents::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 89 of file reportevents.h.

virtual UInt JAUS::ReportEvents::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 88 of file reportevents.h.

const Record::List* JAUS::ReportEvents::GetRecords

(

)

const [inline]

Definition at line 82 of file reportevents.h.

Record::List* JAUS::ReportEvents::GetRecords

(

)

[inline]

Definition at line 81 of file reportevents.h.

virtual bool JAUS::ReportEvents::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 83 of file reportevents.h.

bool ReportEvents::IsLargeDataSet

(

const unsigned int

maxPayloadSize )

const [virtual]

Returns:

True if the contents of the message will be larger than maximum payload size, otherwise false.

Implements JAUS::Message.

Definition at line 218 of file reportevents.cpp.

ReportEvents & ReportEvents::operator=

(

const ReportEvents &

message )

Sets equal to.

Definition at line 239 of file reportevents.cpp.

int ReportEvents::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 182 of file reportevents.cpp.

int ReportEvents::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 144 of file reportevents.cpp.

---

Member Data Documentation

Record::List JAUS::ReportEvents::mEvents [protected]

Events being reported.

Definition at line 96 of file reportevents.h.

---

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

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