JAUS::ConfirmEventRequest Class Reference

This message is used to confirm an event has been created/updated/or canceled. More...

#include <confirmeventrequest.h>

Inheritance diagram for JAUS::ConfirmEventRequest:

List of all members.

Classes
class	Limits
	Contains limits of specific fields in message. More...
Public Member Functions
	ConfirmEventRequest (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	ConfirmEventRequest (const ConfirmEventRequest &message)
	Copy constructor.
	~ConfirmEventRequest ()
	Destructor.
Byte	GetRequestID () const
Byte	GetEventID () const
double	GetConfirmedPeriodicRate () const
Byte	SetRequestID (const Byte id)
Byte	SetEventID (const Byte id)
bool	SetConfirmedPeriodicRate (const double rate)
	Sets the confirmed periodic update rate. If the event type is EveryChange, this value should be 0 (default).
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
ConfirmEventRequest &	operator= (const ConfirmEventRequest &message)
	Sets equal to.
Protected Attributes
Byte	mRequestID
	Local request ID.
Byte	mEventID
	ID of event to cancel.
double	mConfirmedPeriodicRate
	Confirmed periodic rate.

---

Detailed Description

This message is used to confirm an event has been created/updated/or canceled.

Definition at line 55 of file confirmeventrequest.h.

---

Constructor & Destructor Documentation

ConfirmEventRequest::ConfirmEventRequest	(	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 56 of file confirmeventrequest.cpp.

ConfirmEventRequest::ConfirmEventRequest

(

const ConfirmEventRequest &

message )

Copy constructor.

Definition at line 69 of file confirmeventrequest.cpp.

ConfirmEventRequest::~ConfirmEventRequest

(

)

Destructor.

Definition at line 82 of file confirmeventrequest.cpp.

---

Member Function Documentation

void ConfirmEventRequest::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 166 of file confirmeventrequest.cpp.

virtual Message* JAUS::ConfirmEventRequest::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 82 of file confirmeventrequest.h.

double JAUS::ConfirmEventRequest::GetConfirmedPeriodicRate

(

)

const [inline]

Definition at line 75 of file confirmeventrequest.h.

Byte JAUS::ConfirmEventRequest::GetEventID

(

)

const [inline]

Definition at line 74 of file confirmeventrequest.h.

virtual UShort JAUS::ConfirmEventRequest::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 86 of file confirmeventrequest.h.

virtual std::string JAUS::ConfirmEventRequest::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 87 of file confirmeventrequest.h.

virtual UInt JAUS::ConfirmEventRequest::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 83 of file confirmeventrequest.h.

virtual UInt JAUS::ConfirmEventRequest::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 85 of file confirmeventrequest.h.

virtual UInt JAUS::ConfirmEventRequest::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 84 of file confirmeventrequest.h.

Byte JAUS::ConfirmEventRequest::GetRequestID

(

)

const [inline]

Definition at line 73 of file confirmeventrequest.h.

virtual bool JAUS::ConfirmEventRequest::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 79 of file confirmeventrequest.h.

virtual bool JAUS::ConfirmEventRequest::IsLargeDataSet

(

const unsigned int

maxPayloadSize )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 89 of file confirmeventrequest.h.

ConfirmEventRequest & ConfirmEventRequest::operator=

(

const ConfirmEventRequest &

message )

Sets equal to.

Definition at line 178 of file confirmeventrequest.cpp.

int ConfirmEventRequest::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 146 of file confirmeventrequest.cpp.

bool ConfirmEventRequest::SetConfirmedPeriodicRate

(

const double

rate )

Sets the confirmed periodic update rate. If the event type is EveryChange, this value should be 0 (default).

Parameters:

[in]

rate

Requested periodic rate [0,1092] Hz.

Returns:

True if set, false on failure.

Definition at line 98 of file confirmeventrequest.cpp.

Byte JAUS::ConfirmEventRequest::SetEventID

(

const Byte

id )

[inline]

Definition at line 77 of file confirmeventrequest.h.

Byte JAUS::ConfirmEventRequest::SetRequestID

(

const Byte

id )

[inline]

Definition at line 76 of file confirmeventrequest.h.

int ConfirmEventRequest::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 120 of file confirmeventrequest.cpp.

---

Member Data Documentation

double JAUS::ConfirmEventRequest::mConfirmedPeriodicRate [protected]

Confirmed periodic rate.

Definition at line 94 of file confirmeventrequest.h.

Byte JAUS::ConfirmEventRequest::mEventID [protected]

ID of event to cancel.

Definition at line 93 of file confirmeventrequest.h.

Byte JAUS::ConfirmEventRequest::mRequestID [protected]

Local request ID.

Definition at line 92 of file confirmeventrequest.h.

---

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

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