COOLFluiD  Release kernel
COOLFluiD is a Collaborative Simulation Environment (CSE) focused on complex MultiPhysics simulations.
Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
EventHandler Class Reference

#include <EventHandler.hpp>

Inherits SignalHandler, and noncopyable.

Public Member Functions

 ~EventHandler ()
 Destructor. More...
 
template<typename PTYPE , typename FTYPE >
Signalconnect_to_event (const std::string &sname, PTYPE *ptr, FTYPE pfunc)
 Regists a signal on this EventHandler. More...
 
void raise_event (const std::string &ename, SignalArgs &args)
 raises an event and dispatches immedietly to all listeners More...
 
- Public Member Functions inherited from SignalHandler
 ~SignalHandler ()
 
const storage_tsignal_list () const
 
SignalPtr signal (const SignalID &sname)
 
SignalCPtr signal (const SignalID &sname) const
 
SignalRet call_signal (const SignalID &sname, SignalArgs &sinput)
 Calls the signal by providing its name and input. More...
 
SignalRet call_signal (const SignalID &sname, std::vector< std::string > &sinput)
 Calls the signal by providing its name and input. More...
 
bool signal_exists (const SignalID &sname) const
 Checks if a signal exists or not. More...
 
Signalregist_signal (const SignalID &sname)
 Regist signal. More...
 
void unregist_signal (const SignalID &sname)
 Unregist signal. More...
 

Static Public Member Functions

static EventHandlerinstance ()
 

Private Member Functions

 EventHandler ()
 Constructor. More...
 

Additional Inherited Members

- Public Types inherited from SignalHandler
typedef std::vector< SignalPtrstorage_t
 storage type for signals More...
 
- Public Attributes inherited from SignalHandler
storage_t m_signals
 storage of the signals More...
 

Detailed Description

Global Event Handler class

Todo:
make this a component?
Author
Tiago Quintino

Definition at line 25 of file EventHandler.hpp.

Constructor & Destructor Documentation

Destructor.

Definition at line 26 of file EventHandler.cpp.

EventHandler ( )
private

Constructor.

Definition at line 23 of file EventHandler.cpp.

Member Function Documentation

Signal* connect_to_event ( const std::string &  sname,
PTYPE *  ptr,
FTYPE  pfunc 
)
inline

Regists a signal on this EventHandler.

Definition at line 38 of file EventHandler.hpp.

EventHandler & instance ( )
static

Definition at line 16 of file EventHandler.cpp.

void raise_event ( const std::string &  ename,
SignalArgs args 
)

raises an event and dispatches immedietly to all listeners

Definition at line 29 of file EventHandler.cpp.


The documentation for this class was generated from the following files:
Send comments to:
COOLFluiD Web Admin