EventsSystem::Events::Handlers::Handler< HandlerIdList, TargetType, SourceType > Class Template Reference

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

#include <Handler.hpp>

Inherits EventsSystem::Interfaces::SimpleElement<>.

Inheritance diagram for EventsSystem::Events::Handlers::Handler< HandlerIdList, TargetType, SourceType >:

Inheritance graph
[legend]
Collaboration diagram for EventsSystem::Events::Handlers::Handler< HandlerIdList, TargetType, SourceType >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Handler (HandlerIdList iNewHandlerId)
 The defualt constructor of the handler class.
virtual ~Handler ()
 The destructor of Handler.
virtual void runComponent ()=0
 The function does the specific job that the element preforms.

Public Attributes

HandlerIdList iHandlerId
 The handler's id.
const SourceType * oSource
 A pointer to the source object.
TargetType * oTarget
 A pointer to the target object.

Detailed Description

template<class HandlerIdList, class TargetType = void, class SourceType = void>
class EventsSystem::Events::Handlers::Handler< HandlerIdList, TargetType, SourceType >

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

Handler is simple so it doesn't have child nodes. Every handler must drive this class.

There are three types of handlers:

Examples: You can use a handler with a target and source to add the source to the target and save it in the target. You can use a handler with a target only to increase the target by 1. You can use a handler with neither source nor target you can print "Hello world!!!".

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

Definition at line 43 of file Handler.hpp.


Constructor & Destructor Documentation

template<class HandlerIdList, class TargetType = void, class SourceType = void>
EventsSystem::Events::Handlers::Handler< HandlerIdList, TargetType, SourceType >::Handler HandlerIdList  iNewHandlerId  )  [inline]
 

The defualt constructor of the handler class.

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

Definition at line 78 of file Handler.hpp.

template<class HandlerIdList, class TargetType = void, class SourceType = void>
virtual EventsSystem::Events::Handlers::Handler< HandlerIdList, TargetType, SourceType >::~Handler  )  [inline, virtual]
 

The destructor of Handler.

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

Definition at line 91 of file Handler.hpp.


Member Function Documentation

template<class HandlerIdList, class TargetType = void, class SourceType = void>
virtual void EventsSystem::Events::Handlers::Handler< HandlerIdList, TargetType, SourceType >::runComponent  )  [pure virtual]
 

The function does the specific job that the element preforms.

Every tree object must define it.

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

Implements EventsSystem::Interfaces::SimpleElement<>.


Member Data Documentation

template<class HandlerIdList, class TargetType = void, class SourceType = void>
HandlerIdList EventsSystem::Events::Handlers::Handler< HandlerIdList, TargetType, SourceType >::iHandlerId
 

The handler's id.

See also:
HandlerIdList
Author:
Omer Katz
Date:
04/04/2006
Since:
1.0.0 Revision

Definition at line 54 of file Handler.hpp.

template<class HandlerIdList, class TargetType = void, class SourceType = void>
const SourceType* EventsSystem::Events::Handlers::Handler< HandlerIdList, TargetType, SourceType >::oSource
 

A pointer to the source object.

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

Definition at line 62 of file Handler.hpp.

template<class HandlerIdList, class TargetType = void, class SourceType = void>
TargetType* EventsSystem::Events::Handlers::Handler< HandlerIdList, TargetType, SourceType >::oTarget
 

A pointer to the target object.

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

Definition at line 70 of file Handler.hpp.


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