dianadoc/QModule_8hh_source.html

 #ifndef _Q_MODULE_H_

 #define _Q_MODULE_H_


 #include "QBaseModule.hh"


 Q_BEGIN_NAMESPACE


 class QModule : public QBaseModule {


         public:

         QModule();


                 virtual ~QModule();


                 virtual void Init(QEvent& ev) = 0;


                 virtual void Do( QEvent& ev);


                 virtual void Do( QEvent& ev, const QEventList& neighbours);


                 virtual void Done() = 0;


         private:

             void Begin(QEventAssembler& eva);


                  bool Process( QEventAssembler& eva, QEventList& neigh, const bool exec, QEventList& oneigh);


                 void End();


         bool fSkipEvents;


         bool fSkipRequiredNotValid;


         bool fFirstCall;


         size_t fRunOnIteration;


 };


 Q_END_NAMESPACE


 #undef REGISTER_MODULE

 #define REGISTER_MODULE(clazz) REGISTER_MOD(clazz,Diana::QModule)


 #endif

QBaseModule.hh

Q_END_NAMESPACE
#define Q_END_NAMESPACE
Definition: QDiana.hh:22

Q_BEGIN_NAMESPACE
#define Q_BEGIN_NAMESPACE
Definition: QDiana.hh:20

QBaseModule
Base class for modules.
Definition: QBaseModule.hh:57

QEventAssembler
Visitor class of QEvent that provides full handling of QEvent.
Definition: QEventAssembler.hh:22

QEventList
list of references to const QEvent (s)
Definition: QEventList.hh:21

QEvent
diana event
Definition: QEvent.hh:46

QModule
Base class for diana modules.
Definition: QModule.hh:54

QModule::Done
virtual void Done()=0
Done method is called after event loop.

QModule::End
void End()
End method is called after event loop, and calls Done()
Definition: QModule.cc:87

QModule::Process
bool Process(QEventAssembler &eva, QEventList &neigh, const bool exec, QEventList &oneigh)
Process method is called for each event, and calls Do()
Definition: QModule.cc:39

QModule::fSkipRequiredNotValid
bool fSkipRequiredNotValid
Skip events containing non-valid required objects.
Definition: QModule.hh:89

QModule::QModule
QModule()
constuctor
Definition: QModule.cc:7

QModule::Init
virtual void Init(QEvent &ev)=0
Init method is called before event loop.

QModule::fSkipEvents
bool fSkipEvents
flag to skip the Do() execution on filtered events
Definition: QModule.hh:86

QModule::fRunOnIteration
size_t fRunOnIteration
Specify on which iteration the module runs.
Definition: QModule.hh:95

QModule::Do
virtual void Do(QEvent &ev)
Do method is called on each event, getting the event as argument.
Definition: QModule.cc:71

QModule::fFirstCall
bool fFirstCall
flag to check first Do() call
Definition: QModule.hh:92

QModule::Begin
void Begin(QEventAssembler &eva)
Begin method is called before event loop, and calls Init()
Definition: QModule.cc:15

QModule::~QModule
virtual ~QModule()
destructor
Definition: QModule.cc:11