TRGGDL.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 TRGGDL_FLAG_
#define TRGGDL_FLAG_
 
#define TRGGDL_UNDEFINED 999999
 
#include <fstream>
#include <vector>
#include "trg/trg/Clock.h"
#include "trg/trg/SignalVector.h"
#include "trg/trg/SignalBundle.h"
 
#include <framework/database/DBObjPtr.h>
#include <mdst/dbobjects/TRGGDLDBInputBits.h>
#include <mdst/dbobjects/TRGGDLDBFTDLBits.h>
#include <mdst/dbobjects/TRGGDLDBPrescales.h>
#include <trg/gdl/dbobjects/TRGGDLDBAlgs.h>
#include <simulation/dataobjects/SimClockState.h>
#include <framework/dbobjects/HardwareClockSettings.h>
#include <TH1I.h>
 
namespace Belle2 {
  class TRGClock;
  class TRGLink;
 
 
  class TRGGDL {
 
  public:
 
    static TRGGDL* getTRGGDL(const std::string& configFile,
                             unsigned simulationMode = 0,
                             unsigned fastSimulationMode = 0,
                             unsigned firmwareSimulationMode = 0,
                             const std::string& Phase = "Phase",
                             bool algFromDB = true,
                             const std::string& algFilePath = "ftd.alg",
                             int debugLevel = 0,
                             double timquality_threshold_sfin = 0,
                             double timquality_threshold_fine = 0);
 
    static TRGGDL* getTRGGDL(void);
 
  private:
 
    TRGGDL(const std::string& configFile,
           unsigned simulationMode,
           unsigned fastSimulationMode,
           unsigned firmwareSimulationMode,
           const std::string& Phase,
           bool algFromDB = true,
           const std::string& algFilePath = "ftd.alg",
           int debugLevel = 0,
           double timquality_threshold_sfin = 0,
           double timquality_threshold_fine = 0);
 
    virtual ~TRGGDL();
 
    void initialize(void);
 
    void configure(void);
 
    void simulate(void);
 
    void terminate(void);
 
  public:// Selectors
 
    std::string name(void) const;
 
    std::string version(void) const;
 
    std::string configFile(void) const;
 
    unsigned mode(void) const;
 
    unsigned mode(unsigned);
 
    unsigned firmwareSimulationMode(void) const;
 
    void dump(const std::string& message) const;
 
    int debugLevel(void) const;
 
    int debugLevel(int) const;
 
  public:// Event by event information.
 
    void clear(void);
 
    void fastClear(void);
 
    void update(bool mcAnalysis = true);
 
  public:
 
    const TRGClock& systemClock(void) const;
 
    double systemOffsetMC(void) const;
 
    static TRGState decision(const TRGState& input);
 
    static void (* _ftd)(bool* out, const bool* in);
 
    static TRGState timingDecision(const TRGState& input,
                                   TRGState& registers,
                                   bool& logicStillActive);
 
    bool doprescale(int f);
 
    bool isFiredFTDL(std::vector<bool> input, std::string alg);
 
    void checkDatabase() const;
 
    std::vector<bool> getInpBits(void) {return _inpBits;}
 
    std::vector<bool> getFtdBits(void) {return _ftdBits;}
 
    std::vector<bool> getPsnBits(void) {return _psnBits;}
 
  private:
 
    void updateMC(void);
 
    void fastSimulation(void);
 
    void firmwareSimulation(void);
 
    void dataSimulation(void);
 
    void getInput(std::ifstream& ifs);
 
    void getOutput(std::ifstream& ifs);
 
    void getAlgorithm(std::ifstream& ifs);
 
    void accumulateInp(TH1I*);
 
    void accumulateFtd(TH1I*);
 
    void accumulatePsn(TH1I*);
 
    bool isFiredInput(int n) {return _inpBits[n];}
 
    bool isFiredFtdl(int n) {return _ftdBits[n];}
 
    bool isFiredPsnm(int n) {return _psnBits[n];}
 
  private:
 
    static TRGGDL* _gdl;
 
    mutable int _debugLevel;
 
    std::string _configFilename;
 
    unsigned _simulationMode;
 
    unsigned _fastSimulationMode;
 
    unsigned _firmwareSimulationMode;
 
    //Phase
    std::string _Phase;
 
    // Path to algorithm file
    std::string _algFilePath;
 
    const TRGClock& _clock;
 
    const double _offset;
 
    std::vector<TRGLink*> _links;
 
    std::vector<std::string> _input;
 
    std::vector<std::string> _output;
 
    std::vector<std::string> _algorithm;
 
    TRGSignalBundle* _isb;
 
    TRGSignalBundle* _osb;
 
    TRGSignalBundle* _tsb;
 
    TRGSignalBundle* _tosb;
 
    DBObjPtr<TRGGDLDBInputBits> m_InputBitsDB;
    DBObjPtr<TRGGDLDBFTDLBits>  m_FTDLBitsDB;
    DBObjPtr<TRGGDLDBPrescales> m_PrescalesDB;
    DBObjPtr<TRGGDLDBAlgs> m_AlgsDB;
 
    double _timquality_threshold_sfin;
 
    double _timquality_threshold_fine;
 
    std::vector<bool> _inpBits;
    std::vector<bool> _ftdBits;
    std::vector<bool> _psnBits;
    std::vector<std::string> _inpBitNames;
    std::vector<std::string> _oupBitNames;
 
    int getNbitsOup(void) {return _oupBitNames.size();}
    int getNbitsInp(void) {return _inpBitNames.size();}
 
    bool _algFromDB;
 
    StoreObjPtr<SimClockState> m_simClockState;
    DBObjPtr<HardwareClockSettings> m_hwClock;
 
 
    friend class TRGGDLModule;
  };
 
//-----------------------------------------------------------------------------
 
  inline
  int
  TRGGDL::debugLevel(void) const
  {
    return _debugLevel;
  }
 
  inline
  int
  TRGGDL::debugLevel(int a) const
  {
    return _debugLevel = a;
  }
 
  inline
  const TRGClock&
  TRGGDL::systemClock(void) const
  {
    return _clock;
  }
 
  inline
  double
  TRGGDL::systemOffsetMC(void) const
  {
    return _offset;
  }
 
  inline
  unsigned
  TRGGDL::firmwareSimulationMode(void) const
  {
    return _firmwareSimulationMode;
  }
 
  inline
  std::string
  TRGGDL::configFile(void) const
  {
    return _configFilename;
  }
 
 
} // namespace Belle2
 
#endif /* TRGGDL_FLAG_ */