TRGSummary.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 <framework/datastore/RelationsObject.h>
 
#include <string>
 
namespace Belle2 {

  class TRGSummary final : public RelationsObject {
 
  public:

    static const unsigned int c_trgWordSize = 32;

    static const unsigned int c_ntrgWords = 10;

    static constexpr unsigned int c_trgDataSize = c_trgWordSize * c_ntrgWords;

    enum ETimingType {
      TTYP_ECL  = 0,
      TTYP_PID1 = 4,
      TTYP_PID2 = 8,
      TTYP_PID3 = 12,
      TTYP_SELF = 2,
      TTYP_RSV1 = 6,
      TTYP_RSV2 = 10,
      TTYP_RSV3 = 14,
      TTYP_TOP = 1,
      TTYP_CDC = 3,
      TTYP_DPHY = 5,
      TTYP_RAND = 7,
      TTYP_TEST = 9,
      TTYP_RSV4 = 11,
      TTYP_POIS = 13,
      TTYP_NONE = 15
    };

    enum ETimingQuality {
      /* Non. Must not happen for TOP/ECL/CDC timing events */
      TTYQ_NONE = 0,
      /* Coarse */
      TTYQ_CORS = 1,
      /* Fine */
      TTYQ_FINE = 2,
      /* Super Fine */
      TTYQ_SFIN = 3,
    };

    TRGSummary() = default;

    TRGSummary(unsigned int inputBits[10],
               unsigned int ftdlBits[10],
               unsigned int psnmBits[10],
               ETimingType timType);

    bool test() const;

    bool testInput(unsigned int bit) const;

    bool testInput(const std::string& name) const {return testInput(getInputBitNumber(name));}

    bool testFtdl(unsigned int bit) const;

    bool testFtdl(const std::string& name) const {return testFtdl(getOutputBitNumber(name));}

    bool testPsnm(unsigned int bit) const;

    bool testPsnm(const std::string& name) const {return testPsnm(getOutputBitNumber(name));}

    bool isPoissonInInjectionVeto() const
    {
      return m_isPoissonInInjectionVeto;
    }

    void setPoissonInInjectionVeto()
    {
      m_isPoissonInInjectionVeto = true;
    }

    void setTRGSummary(int i, int word) { m_ftdlBits[i] = word;}

    void setPreScale(int i, int bit, int pre) {m_prescaleBits[i][bit] = pre;}

    void setInputBits(int i, int word) {m_inputBits[i] = word;}

    void setFtdlBits(int i, int word) {m_ftdlBits[i] = word;}

    void setPsnmBits(int i, int word) {m_psnmBits[i] = word;}

    unsigned int getTRGSummary(int i) const {return m_ftdlBits[i];}

    unsigned int getPreScale(int i, int bit) const {return m_prescaleBits[i][bit];}

    void setTimType(ETimingType timType) {m_timType = timType;}

    void setTimQuality(ETimingQuality timQuality) {m_timQuality = timQuality;}

    unsigned int getInputBits(const unsigned i) const
    {
      return m_inputBits[i];
    }

    unsigned int getFtdlBits(const unsigned i) const
    {
      return m_ftdlBits[i];
    }

    unsigned int getPsnmBits(const unsigned i) const
    {
      return m_psnmBits[i];
    }

    ETimingType getTimType() const
    {
      return m_timType;
    }

    ETimingQuality getTimQuality() const
    {
      return m_timQuality;
    }

    std::string getInfoHTML() const override;

    unsigned int getInputBitNumber(const std::string& name) const;

    unsigned int getOutputBitNumber(const std::string& name) const;
 
  private:

    std::string outputBitWithColor(bool bit) const;

    unsigned int m_prescaleBits[c_ntrgWords][c_trgWordSize] = {{0}};

    unsigned int m_inputBits[c_ntrgWords] = {0};

    unsigned int m_ftdlBits[c_ntrgWords] = {0};

    unsigned int m_psnmBits[c_ntrgWords] = {0};

    static const int c_Version = 1;

    ETimingType m_timType = TTYP_NONE;

    ETimingQuality m_timQuality = TTYQ_NONE;
    bool m_isPoissonInInjectionVeto = false;

    ClassDefOverride(TRGSummary, 8);
  };
 

} // end namespace Belle2