#include <modules.h>
Inherits ModuleMessage.
Public Member Functions | |
Event (char *anydata, Module *src, std::string eventid) | |
Create a new Event. | |
char * | GetData () |
Get the Event data. | |
Module * | GetSource () |
Get the event Source. | |
std::string | GetEventID () |
Get the event ID. | |
char * | Send () |
Send the Event. | |
Protected Attributes | |
char * | data |
This member holds a pointer to arbitary data set by the emitter of the message. | |
Module * | source |
This is a pointer to the sender of the message, which can be used to directly trigger events, or to create a reply. | |
std::string | id |
The event identifier. |
When the class is properly instantiated it may be sent to all modules using the Send() method, which will trigger the OnEvent method in all modules passing the object as its parameter.
Definition at line 194 of file modules.h.
|
Create a new Event.
Definition at line 345 of file modules.cpp.
|
|
Get the Event data.
Definition at line 347 of file modules.cpp. References data.
00348 { 00349 return this->data; 00350 } |
|
Get the event ID. Use this to determine the event type for safe casting of the data Definition at line 363 of file modules.cpp. References id.
00364 { 00365 return this->id; 00366 } |
|
Get the event Source.
Definition at line 352 of file modules.cpp. References source.
00353 { 00354 return this->source; 00355 } |
|
Send the Event. The return result of an Event::Send() will always be NULL as no replies are expected. Implements ModuleMessage. Definition at line 357 of file modules.cpp. References FOREACH_MOD.
00358 { 00359 FOREACH_MOD OnEvent(this); 00360 return NULL; 00361 } |
|
This member holds a pointer to arbitary data set by the emitter of the message.
Definition at line 199 of file modules.h. Referenced by GetData(). |
|
The event identifier. This is arbitary text which should be used to distinguish one type of event from another. Definition at line 208 of file modules.h. Referenced by GetEventID(). |
|
This is a pointer to the sender of the message, which can be used to directly trigger events, or to create a reply.
Definition at line 203 of file modules.h. Referenced by GetSource(). |