EventLevelTriggerTimeInfo.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
#pragma once
 
#include <TObject.h>
 
namespace Belle2 {
  class EventLevelTriggerTimeInfo : public TObject {
 
  public:

    enum EventT0Source : unsigned int {
      // In case additional subdetectors are included in the EventT0 determination,
      // they must be added here.
      // Flags are set in the EventT0Combiner module.
      c_fromSVD = (1 << 0),
      c_fromCDC = (1 << 1),
      c_fromECL = (1 << 2)
    };

    explicit EventLevelTriggerTimeInfo(bool isValid = false, bool isHER = false, bool revo2 = false,
                                       unsigned int timeSinceLastInjection = c_flagNoInjection,
                                       unsigned int timeSincePrevTrigger = 0,
                                       unsigned int bunchNumber = 0) :
      m_isValid(isValid), m_isHER(isHER), m_revo2(revo2), m_eventT0Source(EventT0Source{0}),
      m_timeSinceLastInjection(timeSinceLastInjection), m_timeSincePrevTrigger(timeSincePrevTrigger),
      m_bunchNumber(bunchNumber) {}

    ~EventLevelTriggerTimeInfo() {}
 
    // Simple Getters
    bool isValid() const {return m_isValid;}
    bool isHER() const {return m_isHER;}
    bool isRevo2() const {return m_revo2;}
    unsigned int getTimeSinceLastInjection() const {return m_timeSinceLastInjection;}
    unsigned int getTimeSincePrevTrigger() const {return m_timeSincePrevTrigger;}
    unsigned int getBunchNumber() const {return m_bunchNumber;}
    bool hasInjection() const {return m_timeSinceLastInjection != c_flagNoInjection;}
 
    // Simple Setters
    void setValid() {m_isValid = true;}
    void setInvalid() {m_isValid = false;}
    void setIsHER(bool isHER) {m_isHER = isHER;}
    void setRevo2(bool revo2) {m_revo2 = revo2;}
    void setTimeSinceLastInjection(unsigned int timeSinceLastInjection) {m_timeSinceLastInjection = timeSinceLastInjection;}
    void setTimeSincePrevTrigger(unsigned int timeSincePrevTrigger) {m_timeSincePrevTrigger = timeSincePrevTrigger;}
    void setBunchNumber(unsigned int bunchNumber) {m_bunchNumber = bunchNumber;}
    void setNoInjection() {m_timeSinceLastInjection = c_flagNoInjection;}
 
    // Additional Functions (not inline)
    double getTimeSinceLastInjectionInMicroSeconds() const;
    double getTimeSincePrevTriggerInMicroSeconds() const;
    int getTimeSinceInjectedBunch() const;
    double getTimeSinceInjectedBunchInMicroSeconds() const;
    int getTriggeredBunchNumberGlobal() const;
 
    // Setters and getters for EventT0Source flags
    void addEventT0SourceFromSVD() { setSources<EventT0Source::c_fromSVD>(true); }

    void unsetEventT0SourceFromSVD() { setSources<EventT0Source::c_fromSVD>(false); }

    bool hasEventT0SourceFromSVD() const { return hasEventT0Sources(EventT0Source::c_fromSVD); }

    void addEventT0SourceFromCDC() { setSources<EventT0Source::c_fromCDC>(true); }

    void unsetEventT0SourceFromCDC() { setSources<EventT0Source::c_fromCDC>(false); }

    bool hasEventT0SourceFromCDC() const { return hasEventT0Sources(EventT0Source::c_fromCDC); }

    void addEventT0SourceFromECL() { setSources<EventT0Source::c_fromECL>(true); }

    void unsetEventT0SourceFromECL() { setSources<EventT0Source::c_fromECL>(false); }

    bool hasEventT0SourceFromECL() const { return hasEventT0Sources(EventT0Source::c_fromECL); }

    void addEventT0Sources(EventT0Source sources) { m_eventT0Source = EventT0Source(m_eventT0Source bitor sources); }

    void unsetEventT0Sources(EventT0Source sources) { m_eventT0Source = EventT0Source(m_eventT0Source bitand ~sources); }

    bool hasEventT0Sources(EventT0Source sources) const { return EventT0Source(m_eventT0Source bitand sources); }

    void resetEventT0Sources() { unsetEventT0Sources(c_fromAllSubdetectors); }

    bool hasAnyEventT0Sources() const { return hasEventT0Sources(c_fromAllSubdetectors); }

    const EventT0Source& getEventT0Sources() const { return m_eventT0Source; }
 
  private:

    template<EventT0Source source>
    void setSources(bool setTo)
    {
      if (setTo) {
        addEventT0Sources(source);
      } else {
        unsetEventT0Sources(source);
      }
    }

    bool m_isValid;
    bool m_isHER;
    bool m_revo2;
    EventT0Source m_eventT0Source;
    unsigned int m_timeSinceLastInjection;
    unsigned int m_timeSincePrevTrigger;
    unsigned int m_bunchNumber;

    static const unsigned int c_flagNoInjection = 0x7FFFFFFF; 
 
    static constexpr EventT0Source c_fromAllSubdetectors = EventT0Source(EventT0Source::c_fromSVD +
                                                           EventT0Source::c_fromCDC +
                                                           EventT0Source::c_fromECL); 
 
    ClassDef(EventLevelTriggerTimeInfo, 2) 
  };

}