MMyModule.cc

Go to the documentation of this file.

#include "MMyModule.hh"
#include "QEvent.hh"
#include "QEventList.hh"
 
 
REGISTER_MODULE(MMyModule)
 
using namespace Diana;
 
void MMyModule::Init(QEvent& ev)
{
    /* This method is called before event loop.
     * Here you can:
     * 1) Get parameters from cfg (see QBaseModule.hh):
     *
     *    GetDouble("parname",defaultVal);
     *    GetInt("parname",defaultVal);
     *    GetBool("parname",defaultVal);
     *    GetString("parname",defaultVal);
     *
     * 2) Add new QObjects to the QEvent (see QEvent.hh):
     *
     *    ev.Add<QObjectType>("name");
     *
     * 3) Set aliases for added objects (see QEvent.hh):
     *
     *    ev.SetAlias("name","path_in_object","alias");
     *
     * 4) Require the presence in the QEvent of the QObjects 
     *    that will be read in the Do():
     *
     *    ev.Require<QObjectType>("owner","name");    or
     *    ev.RequireByLabel<QObjectType>("owner@name");
     *
     * 5) Read/Write global data (see QGlobalDataManager.hh / QGlobalHandle.hh):
     *
     *    GlobalHandle<QObjectType> ghandle("name");
     *    handle.SetChannel(3); // if needed
     *    GlobalData().Get("owner",&ghandle,"DB"); // instead of "DB", you can specify "filename" for file or "" for cached objects.
     *    const QObjectType& gobject = ghandle.Get();
     *    
     *    GlobalHandle<QObjectType> myghandle("name");
     *    myghandle.SetChannel(3); // if needed
     *    myghandle.SetRun(809); // if needed, note that the run number is not available from the event in the Init()
     *    myghandle.Set(object); // object is of type QObjectType   
     *    GlobalData().Set(&myghandle,"filename.root"); 
     *
     * 5) Operate on the sequence execution parameters(see QBaseModule.hh) :
     *
     *    SetRunAgain(); // set to rerun the sequence at the end of the event loop
     *    GetIteration(); // number of sequence (re)iteration
     *    GetRunAgain(); // check if the sequence will be rerun
     */
}
 
//void MMyModule::Do(QEvent& ev, const QEventList& neighbours)
void MMyModule::Do(QEvent& ev)
{
    /* This method is called event by event.
     * The list of neighbours is filled only if activated in 
     * the reader cfg (see QReader.hh, option "NeighboursOn").
     * Use the interface with neighbours declaration in place of this one if neighbours are needed.
     * Here you can:
     * 1) Read QObjects owned by other modules (should match the required QObjects in Init()):
     *
     *    const QObjectType& object = ev.Get<QObjectType>("owner","name"); or
     *    const QObjectType& object = ev.GetByLabel<QObjectType>("owner@name");
     *
     * 1b) Read QObjects owned by other modules from neighbour events (if this interface contains neighbours):
     *     for(size_t i = 0; i < neighbours.Size(); i++) {
     *         const QObjectType& n_object = neighbours[i].Get<QObjectType>("owner","name"); or
     *         const QObjectType& n_object = neighbours[i].GetByLabel<QObjectType>("owner@name");
     *     }
     * 2) Write QObjects owned by this module:
     *
     *    QObjectType& myObject = ev.Get<QObjectType>("name");
     *    myObject = ...
     *
     * 3) Read/Write global data.
     *
     * 4) Operate on the sequence execution parameters(see QBaseModule.hh).
     */
}
 
void MMyModule::Done()
{
    /* This method is called at the end of the event loop. 
     * Here you can:
     *
     * 1) Operate on the sequence execution parameters(see QBaseModule.hh).
     *
     * 2) Read/Write global data.
     */
}