source: JEM-EUSO/esaf_lal/tags/v1_r0/esaf/packages/simulation/detector/electronics/include/TriggerEngine.hh @ 117

// ESAF : Euso Simulation and Analysis Framework
// $Id: TriggerEngine.hh 2967 2011-07-14 15:23:29Z fenu $
// M. Pallavicini created Oct, 24 2003
// Base class for any triggering algorythm
// It acts as a visitor (friend class) of MacroCellData
//

#ifndef __TRIGGERENGINE_HH_
#define __TRIGGERENGINE_HH_

#include <map>
#include "euso.hh"
#include "EsafConfigurable.hh"
#include "EsafMsgSource.hh"
#include "Etypes.hh"

class MacroCellData;

class TriggerEngine : public EsafConfigurable, public EsafMsgSource {
public:

    // ctor 
    TriggerEngine(const string& name, ETriggerTypeIdentifier);

    // dtor
    virtual ~TriggerEngine();
    
    // factory method for engines
    static map<ETriggerTypeIdentifier,TriggerEngine*> &GetEngines( ETriggerTypeIdentifier );

    // return engine name
    inline const string& GetName() const { return fName; } 

    // simulate trigger
    virtual void Simulate( MacroCellData* ) = 0;

    // true if we got a trigger
    inline Bool_t HasTriggered() const { return fHasTriggered; }

    // get trigger word (bitfield for all trigger engines)
    static Int_t GetTriggerWord() {return fTriggerWord;}

    // reset trigger word
    static void ResetTriggerWord() {fTriggerWord=0; fTrgWords.clear();}

    //get trgwords
    static const map<Int_t, Int_t>& GetTrgWords() {return fTrgWords;}
    
    // get gtu at which trigger occurred
    inline Int_t GetGtuTrigger() const { return fGtuTrigger;}

    EsafConfigClass(Electronics,TriggerEngine);

protected:
    // set trigger flag reserved to child classes
    inline void SetTrigger() { fHasTriggered = kTRUE; fTriggerWord |= (Int_t)GetTriggerId(); }
    void SetTrigger(Int_t word);

    // get trigger id reserved to child classes
    inline Int_t GetTriggerId() const { return fTrgId;}

    // set gtu trigger
    inline void SetGtuTrigger(Int_t gtu) { fGtuTrigger = gtu; }

    inline void SetGtuTriggerCCB(Int_t gtu) { fGtuTriggerCCB = gtu; }
    inline Int_t GetGtuTriggerCCB() { return fGtuTriggerCCB; }
  
private:
    // name of this engine
    string fName;

    // trigger id for this engine
    ETriggerTypeIdentifier fTrgId;
    
    // true if triggered occurred
    Bool_t fHasTriggered;

    // gtu at which trigger occurred
  Int_t fGtuTrigger,fGtuTriggerCCB;

    // factory method for trigger engines
    // right now designed to provide the same trigger structure for all
    // macrocells
    static map<ETriggerTypeIdentifier,TriggerEngine*> *fEngines;

    // trigger word is the same for all engines
    // bit field of ETriggerTypeIdentifier
    static Int_t fTriggerWord;

    //trigger word map for triggers with multiple config running in parallel
    static map<Int_t, Int_t> fTrgWords;

    ClassDef(TriggerEngine,0)
};

#endif  /* __TRIGGERENGINE_HH_ */