FrontEnd.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.                  *
 **************************************************************************/
 
//-----------------------------------------------------------------------------
// Description : A class to represent a CDC front-end board
//-----------------------------------------------------------------------------
 
#ifndef TRGCDCFrontEnd_FLAG_
#define TRGCDCFrontEnd_FLAG_
 
#include <fstream>
#include <string>
#include "trg/trg/Board.h"
#include "trg/trg/SignalVector.h"
#include "trg/trg/SignalBundle.h"
 
#ifdef TRGCDC_SHORT_NAMES
#define TCFrontEnd TRGCDCFrontEnd
#endif
 
namespace Belle2 {
  class TRGCDCWire;
 
  class TRGCDCFrontEnd
    : public TRGBoard,
      public std::vector<const TRGCDCWire*> {
 
  public:// enum
    enum boardType {
      innerInside  = 0,       // inner of the inner-most super layer
      innerOutside = 1,       // outer of the inner-most super layer
      outerInside  = 2,       // inner of the ouer super layer
      outerOutside = 3,       // outer of the ouer super layer
      unknown = 999
    };
 
  public:
 
    TRGCDCFrontEnd(const std::string& name,
                   boardType type,
                   const TRGClock& systemClock,
                   const TRGClock& dataClock,
                   const TRGClock& userClock);
 
    virtual ~TRGCDCFrontEnd();
 
 
  public:// Selectors
 
    static std::string version(void);
 
    boardType type(void) const;
 
  public:// Modifiers
 
    void simulate(void);
 
    //    TRGSignalBundle  output(void) { return *_osb;};
    TRGSignalBundle* getOSB(void) const { return _osb; };
 
 
  public:// VHDL utilities
 
    static TRGState packerInnerInside(const TRGState& input);
 
    static TRGState packerInnerOutside(const TRGState& input);
 
    static TRGState packerOuterInside(const TRGState& input);
 
    static TRGState packerOuterOutside(const TRGState& input);
 
    static void unpackerInnerInside(const TRGState& input,
                                    const TRGState& output);
 
    static void unpackerInnerOutside(const TRGState& input,
                                     const TRGState& output);
 
    static void unpackerOuterInside(const TRGState& input,
                                    const TRGState& output);
 
    static void unpackerOuterOutside(const TRGState& input,
                                     const TRGState& output);
 
    static int implementation(const boardType& type, std::ofstream&);
 
    static int implementationPort(const boardType& type, std::ofstream&);
 
  public:// Configuration
 
    void push_back(const TRGCDCWire*);
 
    void dump(const std::string& message = "",
              const std::string& pre = "") const;
 
    void dump_log(void) const;
    void dump_log_innerInside(void) const;
    void dump_log_innerOutside(void) const;
    void dump_log_outerInside(void) const;
    void dump_log_outerOutside(void) const;
 
//  public: // allow Merger class to access FrontEnd data
 
    //friend class TRGCDCMerger;
 
  private:
 
    boardType _type;
 
    TRGSignalBundle* _isb;
 
    TRGSignalBundle* _osb;
  };
 
//-----------------------------------------------------------------------------
 
} // namespace Belle2
 
#endif /* TRGCDCFrontEnd_FLAG_ */