SignalBundle.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 TRGSignalBundle_FLAG_
#define TRGSignalBundle_FLAG_
 
#include <vector>
#include "trg/trg/Clock.h"
 
namespace Belle2 {
  class TRGSignal;
  class TRGSignalVector;
  class TRGState;
 
  class TRGSignalBundle : public std::vector<TRGSignalVector*> {
 
  public:
 
//  TRGSignalBundle(const TRGClock & = Belle2_GDL::GDLSystemClock);
    explicit TRGSignalBundle(const TRGClock&);
 
    TRGSignalBundle(const std::string& name,
//        const TRGClock & = Belle2_GDL::GDLSystemClock);
                    const TRGClock&);
 
    TRGSignalBundle(const std::string& name,
                    const TRGClock& clock,
                    const TRGSignalBundle& input,
                    const unsigned outputBitSize,
                    TRGState(* packer)(const TRGState&));
 
    TRGSignalBundle(const std::string& name,
                    const TRGClock& clock,
                    const TRGSignalBundle& input,
                    const unsigned outputBitSize,
                    const unsigned registerBitSize,
                    TRGState(* packer)(const TRGState& in,
                                       TRGState& registers,
                                       bool& logicStillActive));
 
    virtual ~TRGSignalBundle();
 
  public:// Selectors
 
    const std::string& name(void) const;
 
    const std::string& name(const std::string& newName);
 
    const TRGClock& clock(void) const;
 
    bool active(void) const;
 
    std::vector<int> stateChanges(void) const;
 
    TRGState state(int clockPosition) const;
 
    TRGSignal ored(void) const;
 
    void dump(const std::string& message = "",
              const std::string& pre = "") const;
 
    void dumpCOE(const std::string& fileName = "",
                 int start = 0,
                 int stop = 0) const;
 
  public:// Operators
 
    const TRGClock& clock(const TRGClock&);
 
    void readCOE(const std::string& fileName = "");
 
  private:
 
    std::string _name;
 
    const TRGClock* _clock;
  };
 
//-----------------------------------------------------------------------------
 
  inline
  const std::string&
  TRGSignalBundle::name(void) const
  {
    return _name;
  }
 
  inline
  const std::string&
  TRGSignalBundle::name(const std::string& newName)
  {
    return _name = newName;
  }
 
  inline
  const TRGClock&
  TRGSignalBundle::clock(void) const
  {
    return * _clock;
  }
 
} // namespace Belle2
 
#endif /* TRGSignalBundle_FLAG_ */