EventsSystem::Events::Event< ConstructionPolicy, DestructionPolicy > Class Template Reference

This class provides the basic interface for all of the events. More...

#include <Event.hpp>

Inherits EventsSystem::Interfaces::ComplexElement.

Inheritance diagram for EventsSystem::Events::Event< ConstructionPolicy, DestructionPolicy >:

Inheritance graph
[legend]
Collaboration diagram for EventsSystem::Events::Event< ConstructionPolicy, DestructionPolicy >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

void runComponent ()
 The function runs through the nodes list and invokes its components.

Protected Member Functions

 Event ()
 The constructor of Event.
 ~Event ()

Private Attributes

DestructionPolicy dspPolicy
 The destruction policy.

Detailed Description

template<class ConstructionPolicy, class DestructionPolicy = Policies::EventDestructionPolicy>
class EventsSystem::Events::Event< ConstructionPolicy, DestructionPolicy >

This class provides the basic interface for all of the events.

Event is complex so it has child nodes. They may be handlers or events. Every event must drive this class.

The ConstructionPolicy template parameter is used to stimulate an abstract constructor. This policy adds the elements to the queue. Every event must have a construction policy of it's own.

The DestructionPolicy template parameter is used to destruct the event. There is a default destruction policy so there is no need to implant it to every class. The only reason to re-implant it is if there is some kind of of special resource that needs to be handled.

Author:
Omer Katz
Date:
06/10/2005
Since:
1.0.0

Definition at line 86 of file Event.hpp.


Constructor & Destructor Documentation

template<class ConstructionPolicy, class DestructionPolicy = Policies::EventDestructionPolicy>
EventsSystem::Events::Event< ConstructionPolicy, DestructionPolicy >::Event  )  [inline, protected]
 

The constructor of Event.

It is protected so the only classes that can use it are the driven classes

Author:
Omer Katz
Date:
06/10/2005
Since:
1.0.0

Definition at line 104 of file Event.hpp.

template<class ConstructionPolicy, class DestructionPolicy = Policies::EventDestructionPolicy>
EventsSystem::Events::Event< ConstructionPolicy, DestructionPolicy >::~Event  )  [inline, protected]
 

Definition at line 110 of file Event.hpp.


Member Function Documentation

template<class ConstructionPolicy, class DestructionPolicy = Policies::EventDestructionPolicy>
void EventsSystem::Events::Event< ConstructionPolicy, DestructionPolicy >::runComponent  )  [inline, virtual]
 

The function runs through the nodes list and invokes its components.

Author:
Omer Katz
Date:
06/10/2005
Since:
1.0.5

Implements EventsSystem::Interfaces::ComplexElement.

Definition at line 118 of file Event.hpp.

References EventsSystem::Interfaces::Element::runComponent().

Here is the call graph for this function:


Member Data Documentation

template<class ConstructionPolicy, class DestructionPolicy = Policies::EventDestructionPolicy>
DestructionPolicy EventsSystem::Events::Event< ConstructionPolicy, DestructionPolicy >::dspPolicy [private]
 

The destruction policy.

It is declared on the memory instead of a temporary decleration because you can't create a temporary object after you destruct the object.

Definition at line 94 of file Event.hpp.


The documentation for this class was generated from the following file:
Generated on Thu Apr 13 12:15:14 2006 for Events System by  doxygen 1.4.6-NO