This message allows the requestor to request a rate or change for an existing event. More...

#include <updateevent.h>

Inheritance diagram for JAUS::UpdateEvent:

Classes
class	Limits
	Contains limits of specific fields in message. More...
Public Member Functions
	UpdateEvent (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	UpdateEvent (const UpdateEvent &message)
	Copy constructor.
	~UpdateEvent ()
	Destructor.
void	SetType (const Events::Type type)
void	SetEventID (const Byte id)
void	SetRequestID (const Byte id)
bool	SetRequestedPeriodicRate (const double rate)
	Sets the requested periodic update rate. If the event type is EveryChange, this value should be 0.
bool	SetQueryMessage (const Message *queryMessage)
	Sets the query message which will determine the type of Report for the event.
bool	SetQueryMessage (const UShort messageCode, const Packet &queryPayload)
	Sets the query message which will determine the type of Report for the event.
Events::Type	GetType () const
Byte	GetEventID () const
Byte	GetRequestID () const
double	GetRequestedPeriodicRate () const
UShort	GetQueryMessageCode () const
const Packet *	GetQueryMessage () const
virtual bool	IsCommand () const
virtual bool	IsResponseToMessage (const Message *requestingMessage) const
	Method used to verify if this Message is a response to a requesting Query or Command message.
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
UpdateEvent &	operator= (const UpdateEvent &message)
	Sets equal to.
Protected Attributes
Events::Type	mType
	Event type.
Byte	mRequestID
	Local request ID field.
Byte	mEventID
	Event ID to be updated.
double	mRequestedPeriodicRate
	Requested periodic event rate [0-1092] Hz.
UShort	mQueryMessageCode
	Messge code for the Query Message specifying type of Report.
Packet	mQueryMessage
	Contents of the query message.

Detailed Description

This message allows the requestor to request a rate or change for an existing event.

Definition at line 56 of file updateevent.h.

Constructor & Destructor Documentation

UpdateEvent::UpdateEvent	(	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 59 of file updateevent.cpp.

UpdateEvent::UpdateEvent ( const UpdateEvent & message )

Copy constructor.

Definition at line 75 of file updateevent.cpp.

UpdateEvent::~UpdateEvent ( )

Destructor.

Definition at line 91 of file updateevent.cpp.

Member Function Documentation

void UpdateEvent::ClearMessageBody ( ) [virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 278 of file updateevent.cpp.

virtual Message* JAUS::UpdateEvent::Clone ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 90 of file updateevent.h.

Byte JAUS::UpdateEvent::GetEventID ( ) const [inline]

Definition at line 81 of file updateevent.h.

virtual UShort JAUS::UpdateEvent::GetMessageCodeOfResponse ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 94 of file updateevent.h.

virtual std::string JAUS::UpdateEvent::GetMessageName ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 95 of file updateevent.h.

virtual UInt JAUS::UpdateEvent::GetPresenceVector ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 91 of file updateevent.h.

virtual UInt JAUS::UpdateEvent::GetPresenceVectorMask ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 93 of file updateevent.h.

virtual UInt JAUS::UpdateEvent::GetPresenceVectorSize ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 92 of file updateevent.h.

const Packet* JAUS::UpdateEvent::GetQueryMessage ( ) const [inline]

Definition at line 85 of file updateevent.h.

UShort JAUS::UpdateEvent::GetQueryMessageCode ( ) const [inline]

Definition at line 84 of file updateevent.h.

double JAUS::UpdateEvent::GetRequestedPeriodicRate ( ) const [inline]

Definition at line 83 of file updateevent.h.

Byte JAUS::UpdateEvent::GetRequestID ( ) const [inline]

Definition at line 82 of file updateevent.h.

Events::Type JAUS::UpdateEvent::GetType ( ) const [inline]

Definition at line 80 of file updateevent.h.

virtual bool JAUS::UpdateEvent::IsCommand ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 86 of file updateevent.h.

virtual bool JAUS::UpdateEvent::IsLargeDataSet ( const unsigned int maxPayloadSize ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 97 of file updateevent.h.

bool UpdateEvent::IsResponseToMessage ( const Message * requestingMessage ) const [virtual]

Method used to verify if this Message is a response to a requesting Query or Command message.

This method verifies that the destination ID of the requestingMessage matches the source ID of this message and that the result of GetMessageCodeOfResponse for the requestingMessage matchings the message code of this method. Overload this method to check other parameters.

Parameters:

[in] requestingMessage Original query or command message that you want to see if this message is a response to.

Returns:: True if this message is a response, otherwise false.

Reimplemented from JAUS::Message.

Definition at line 180 of file updateevent.cpp.

UpdateEvent & UpdateEvent::operator= ( const UpdateEvent & message )

Sets equal to.

Definition at line 294 of file updateevent.cpp.

int UpdateEvent::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 249 of file updateevent.cpp.

void JAUS::UpdateEvent::SetEventID ( const Byte id ) [inline]

Definition at line 75 of file updateevent.h.

bool UpdateEvent::SetQueryMessage ( const Message * queryMessage )

Sets the query message which will determine the type of Report for the event.

Parameters:

[in] queryMessage Pointer to Message object to get Message Code and payload for query.

Returns:: True if set, false on failure.

Definition at line 129 of file updateevent.cpp.

bool UpdateEvent::SetQueryMessage	(	const UShort	messageCode,
		const Packet &	queryPayload
	)

Sets the query message which will determine the type of Report for the event.

Parameters:

[in]	messageCode	Query message code which will determine Report type.
[in]	queryPayload	Query payload data (serialized message body only, no 2 byte message code).