ChangedUserDataEvent Class Reference

#include <ChangedUserDataEvent.h>

Inherits Event.

Collaboration diagram for ChangedUserDataEvent:

[legend]

List of all members.

Public Types
typedef EventFactory < ChangedUserDataEvent >	Factory
Public Member Functions
	ChangedUserDataEvent ()
	ChangedUserDataEvent (UserData *data)
virtual	~ChangedUserDataEvent ()
virtual void	encode (NetMessage *message)
virtual void	decode (NetMessage *message)
virtual void	execute ()
virtual std::string	toString ()
Protected Attributes
unsigned	userId
	ID of the user who changed his UserData.
UserData *	data
	New version of UserData.

---

Detailed Description

Event for changes on local UserData. This event is sent out when the user changes information of his local UserData. It is sent to all other participants to notify them about the changes.

---

Member Typedef Documentation

typedef EventFactory<ChangedUserDataEvent> ChangedUserDataEvent::Factory

---

Constructor & Destructor Documentation

ChangedUserDataEvent::ChangedUserDataEvent

(

)

Empty constructor for factory.

ChangedUserDataEvent::ChangedUserDataEvent

(

UserData *

data

)

Constructor gets userId from UserDatabase and stores UserData.

Parameters:

data

New UserData object.

ChangedUserDataEvent::~ChangedUserDataEvent

(

)

[virtual]

Empty destructor.

---

Member Function Documentation

void ChangedUserDataEvent::decode

(

NetMessage *

message

)

[virtual]

Reimplemented from Event.

void ChangedUserDataEvent::encode

(

NetMessage *

message

)

[virtual]

Todo:

should Event::decode() and Event::encode() be protected?

describe Event::decode() and Event::encode()

Reimplemented from Event.

void ChangedUserDataEvent::execute

(

)

[virtual]

Process the Event.

Todo:

write more precise description

Implements Event.

std::string ChangedUserDataEvent::toString

(

)

[virtual]

Return a string representation of the Event, containing all attributes.

Reimplemented from Event.

---

Member Data Documentation

UserData* ChangedUserDataEvent::data [protected]

New version of UserData.

unsigned ChangedUserDataEvent::userId [protected]

ID of the user who changed his UserData.

---

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

• src/inVRs/Modules/3DPhysics/ChangedUserDataEvent.h
• src/inVRs/Modules/3DPhysics/ChangedUserDataEvent.cpp