TrgBit.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.                  *
 **************************************************************************/
#ifndef TRGBIT_h
#define TRGBIT_h
 
#include <string>
#include <framework/dataobjects/EventMetaData.h>
#include <mdst/dataobjects/TRGSummary.h>
#include <trg/gdl/TrgBitInput.h>
#include <trg/gdl/TrgBitOutput.h>
 
const int N_INPUT_ARRAY = 5;
const int N_OUTPUT_ARRAY = 5;
const int N_PSNM_ARRAY = 10;
const int N_BITS_RESERVED = 200;
 
namespace Belle2 {
  class TrgBit {
 
  public:
 
    TrgBit();
 
    virtual ~TrgBit();
 
  public:
    class InputBitPattern {
 
    public:
      InputBitPattern() : _pattern{}   {}; //TODO is it good default?
 
      virtual ~InputBitPattern() {};
 
    public:
 
      void set(unsigned pattern, unsigned wordPosition);
 
      bool isFired(unsigned bit) const;
 
    public:// Operators
      int operator == (InputBitPattern&);
 
      int operator [](unsigned);
 
    private:
 
      unsigned _pattern[6];
 
    };
 
    class OutputBitPattern {
 
    public:
      OutputBitPattern() : _pattern{}  {}; //TODO is it good default?
 
      virtual ~OutputBitPattern() {};
 
    public:
 
      void set(unsigned pattern, unsigned wordPosition);
 
      bool isFired(unsigned bit) const;
 
    public:// Operators
 
      int operator == (OutputBitPattern&);
 
      int operator [](unsigned);
 
    private:
 
      unsigned _pattern[6];
 
    };
 
  private:
 
    unsigned _exp;
    unsigned _run;
 
    // configuration numbers
    unsigned nconf_psnm;
    unsigned nconf_ftdl;
    unsigned nconf_input;
 
    // number of using bits
    unsigned n_input;
    unsigned n_output;
 
    // Whether hit information is filled or not.
    // This is true when TRGSummary class is available.
    bool _isFiredFilled;
 
  public:// Selectors
 
    std::string version(void) const;
 
    unsigned preScaleValue(output A) const;
    unsigned preScaleValue(unsigned i) const;
 
    void printPreScaleValues(void) const;
    void printConf(void) const;
 
    bool isFired(output bitname) const;
    bool isFired(const char* bitname) const;
    bool isFired(input bitname) const;
    bool isFiredInput(unsigned ith_bit) const;
    bool isFiredInput(input bitname) const;
    bool isFiredInput(const char* bitname) const;
    bool isFiredFtdl(unsigned ith_bit) const;
    bool isFiredFtdl(output bitname) const;
    bool isFiredFtdl(const char* bitname) const;
    bool isFiredPsnm(unsigned ith_bit) const;
    bool isFiredPsnm(output bitname) const;
    bool isFiredPsnm(const char* bitname) const;
 
    unsigned getNumOfInputs(void) {return n_input;}
    unsigned getNumOfOutputs(void) {return n_output;}
 
    unsigned getOutputBitNum(const char* bitname) const;
    unsigned getOutputBitNum(output a) {return _outputMap[nconf_ftdl][a];}
 
    unsigned getInputBitNum(const char* bitname) const;
    unsigned getInputBitNum(input a) {return _inputMap[nconf_input][a];}
 
    int getBitNum(const char* bitname) const;
 
    bool isFiredFilled(void) {return _isFiredFilled;}
 
    bool isUsed(input a) const;
    bool isUsed(output a) const;
    bool isUsed(const char* bitname) const;
 
    const char* getInputBitName(unsigned ith_bit) const;
    const char* getOutputBitName(unsigned ith_bit) const;
 
    TRGSummary::ETimingType getTimingSource(void) const;
 
    std::vector<unsigned> getInputVector(void) {return _itdVector;}
    std::vector<unsigned> getFtdlVector(void) {return _ftdVector;}
    std::vector<unsigned> getPsnmVector(void) {return _psnVector;}
 
  public:
 
    std::string versionFTDL(void) const;
 
  private:// Modifiers
 
    // Set configuration version from exp, run number
    // Valid only for physics run, not for cosmic.
    void mapNumber(unsigned exp, unsigned run);
 
  private:
 
    static const std::string _ftdlVersion[2];
    static const unsigned _inputMap[N_INPUT_ARRAY][N_BITS_RESERVED];
    static const unsigned _outputMap[N_OUTPUT_ARRAY][N_BITS_RESERVED];
    static const unsigned _psnmValues[N_PSNM_ARRAY][N_BITS_RESERVED];
    static const char* _inputBitNames[N_BITS_RESERVED];
    static const char* _outputBitNames[N_BITS_RESERVED];
 
    TRGSummary::ETimingType timtype;
 
    InputBitPattern _input;
    OutputBitPattern _ftdl;
    OutputBitPattern _psnm;
 
    std::vector<unsigned> _itdVector;
    std::vector<unsigned> _ftdVector;
    std::vector<unsigned> _psnVector;
 
  };
 
}
 
#endif