CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Public Member Functions | Protected Member Functions | List of all members
ctkEventBus::ctkEventDispatcherLocal Class Reference

#include <Plugins/org.commontk.eventbus/ctkEventDispatcherLocal.h>

Inheritance diagram for ctkEventBus::ctkEventDispatcherLocal:
Inheritance graph
[legend]
Collaboration diagram for ctkEventBus::ctkEventDispatcherLocal:
Collaboration graph
[legend]

Public Member Functions

 ctkEventDispatcherLocal ()
 object constructor. More...
 
virtual void notifyEvent (ctkBusEvent &event_dictionary, ctkEventArgumentsList *argList=NULL, QGenericReturnArgument *returnArg=NULL) const
 Emit event corresponding to the given id locally to the application. More...
 
- Public Member Functions inherited from ctkEventBus::ctkEventDispatcher
bool addObserver (ctkBusEvent &props)
 Add the observer to the events. More...
 
 ctkEventDispatcher ()
 object constructor. More...
 
bool isLocalSignalPresent (const QString topic) const
 method used to check if the given signal has been already registered for the given id. More...
 
bool registerSignal (ctkBusEvent &props)
 register custom signals use by objects to raise them events. More...
 
bool removeObserver (const QObject *obj, const QString topic, bool qt_disconnect=true)
 remove the callback from the observer's hash. More...
 
bool removeObserver (ctkBusEvent &props)
 remove the callback from the observer's hash. More...
 
bool removeSignal (const QObject *obj, const QString topic="", bool qt_disconnect=true)
 Remove the signal from the signal's hash. More...
 
bool removeSignal (ctkBusEvent &props)
 Remove the signal from the signal's hash. More...
 
void resetHashes ()
 clean the signal and callback hashes. More...
 
virtual ~ctkEventDispatcher ()
 object destructor. More...
 

Protected Member Functions

void initializeGlobalEvents ()
 Register MAF global events. More...
 
- Protected Member Functions inherited from ctkEventBus::ctkEventDispatcher
bool removeEventItem (ctkBusEvent &props)
 Interanl method used to remove the given event property. More...
 
ctkEventItemListType signalItemProperty (const QString topic) const
 Return the signal item property associated to the given ID. More...
 

Additional Inherited Members

- Signals inherited from ctkEventBus::ctkEventDispatcher
void notifyDefaultEvent ()
 Default notification signals for default events. More...
 
void remoteCommunicationDone ()
 Signal used to notify to observers that the remote communication has been terminated with success. More...
 
void remoteCommunicationFailed ()
 Signal used to notify to observers that the remote communication failed. More...
 

Detailed Description

Class name: ctkEventDispatcherLocal This allows dispatching events coming from local application to attached observers.

Definition at line 24 of file ctkEventDispatcherLocal.h.

Constructor & Destructor Documentation

◆ ctkEventDispatcherLocal()

ctkEventBus::ctkEventDispatcherLocal::ctkEventDispatcherLocal ( )

object constructor.

Member Function Documentation

◆ initializeGlobalEvents()

void ctkEventBus::ctkEventDispatcherLocal::initializeGlobalEvents ( )
protectedvirtual

Register MAF global events.

Reimplemented from ctkEventBus::ctkEventDispatcher.

◆ notifyEvent()

virtual void ctkEventBus::ctkEventDispatcherLocal::notifyEvent ( ctkBusEvent event_dictionary,
ctkEventArgumentsList argList = NULL,
QGenericReturnArgument *  returnArg = NULL 
) const
virtual

Emit event corresponding to the given id locally to the application.

Reimplemented from ctkEventBus::ctkEventDispatcher.


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