Event Class Reference

Base class for all event message. More...

#include <event.h>

Inheritance diagram for Event:

List of all members.

Public Member Functions
	Event (const int eventID=-1)
	Constructor.
	~Event ()
	Destructor.
const int	getEventID () const
	Returns the event ID.
void	setEventID (const int eventID)
	Sets the event ID.
virtual void	processMessage () const =0
	Abstract method which process the event.
void	toXML (XMLWriter &) const
	Write a XML representation of this object.
virtual void	toXMLExt (XMLWriter &) const =0
	Specific method for derived class to write their own XML specific representation.
virtual std::string	toString () const
	Returns a string representation of the event.
Static Public Attributes
static const char *	EVENT_ROOT = "event"
	Event root node.
static const char *	CONTACTID_ATTR = "contact-id"
	Possible value of ID_ATTR. It means that the param node will containt a contact id value.
static const char *	STATE_ATTR = "state"
	Possible value of ID_ATTR. It means that the param node will containt a state value.
static const char *	ID_ATTR = "id"
	Attribute used to inform which type of information we are going to provide.
static const char *	PARAM_NODE = "param"
	Param node.

---

Detailed Description

Base class for all event message.

Author:

Sylvain Archenault <sylvain.archenault@laposte.net>

Yves Houpert <yves.houpert@insa-rouen.fr>

---

Constructor & Destructor Documentation

Event::Event (  const int  eventID = -1  )

Constructor. Parameters: eventID  Event ID

---

Member Function Documentation

const int Event::getEventID (   )  const [inline]

Returns the event ID. Returns: Event ID.

void Event::setEventID (  const int  eventID  )  [inline]

Sets the event ID. Parameters: eventID  Event ID.

std::string Event::toString (   )  const [virtual]

Returns a string representation of the event. Returns: String representation. Implements BaseMessage. Reimplemented in StateChangedEvent.

virtual void Event::toXMLExt (  XMLWriter &   )  const [pure virtual]

Specific method for derived class to write their own XML specific representation. Parameters: writer  XMLWriter object used to write XML representation. Implemented in StateChangedEvent.

---

Member Data Documentation

const char * Event::CONTACTID_ATTR = "contact-id" [static]

Possible value of ID_ATTR. It means that the param node will containt a contact id value. More precisely, the contact ID is the contact ID which state has changed.

const char * Event::ID_ATTR = "id" [static]

Attribute used to inform which type of information we are going to provide. It is used in param node.

const char * Event::STATE_ATTR = "state" [static]

Possible value of ID_ATTR. It means that the param node will containt a state value. More precisely, it's the new state of the contact.

---

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

• GM/GM4/Projets/messenger/QtClient/src/Message/event.h
• GM/GM4/Projets/messenger/QtClient/src/Message/event.cpp

---