Signal.h

//-----------------------------------------------------------------------------
// $Id$
//-----------------------------------------------------------------------------
// Filename : TRGSignal.h
// Section  : TRG
// Owner    : Yoshihito Iwasaki
// Email    : yoshihito.iwasaki@kek.jp
//-----------------------------------------------------------------------------
// Description : A class to represent a digitized signal.
//-----------------------------------------------------------------------------
// $Log$
//-----------------------------------------------------------------------------
 
#ifndef TRGSignal_FLAG_
#define TRGSignal_FLAG_
 
#include <vector>
#include "trg/trg/Clock.h"
#include "trg/trg/Time.h"
 
namespace Belle2 {
  class TRGSignal {
 
  public:
 
    TRGSignal(const TRGClock& = Belle2_GDL::GDLSystemClock);
 
    TRGSignal(const TRGTime& t0, const TRGTime& t1);
 
    TRGSignal(const TRGClock& c, int t0, int t1);
 
    TRGSignal(const TRGClock& c, double t0, double t1);
 
    TRGSignal(const std::string& name,
              const TRGClock& = Belle2_GDL::GDLSystemClock);
 
    TRGSignal(const TRGSignal&);
 
    TRGSignal(const TRGTime&);
 
    virtual ~TRGSignal();
 
  public:// Selectors
 
    const std::string& name(void) const;
 
    const TRGClock& clock(void) const;
 
    unsigned nSignals(void) const;
 
    unsigned nEdges(void) const;
 
    unsigned width(unsigned i = 0) const;
 
    bool active(void) const;
 
    bool active(int clk0, int clk1) const;
 
    bool state(int clockPosition) const;
 
    bool riseEdge(int clockPosition) const;
 
    std::vector<int> stateChanges(void) const;
 
    void dump(const std::string& message = "",
              const std::string& pre = "") const;
 
  public:// Modifiers
 
    const std::string& name(const std::string& newName);
 
    void clear(void);
 
    const TRGClock& clock(const TRGClock&);
 
    const TRGSignal& set(double t0, double t1);
 
    const TRGSignal& set(int t0, int t1, bool state = true);
 
    const TRGSignal& unset(int t0, int t1);
 
    const TRGSignal& invert(void);
 
  public:// Operators
 
    TRGSignal operator&(const TRGSignal&) const;
 
    TRGSignal operator&(const TRGTime&) const;
 
    TRGSignal& operator&=(const TRGSignal&);
 
    TRGSignal& operator&=(const TRGTime&);
 
    TRGSignal operator|(const TRGSignal&) const;
 
    TRGSignal operator|(const TRGTime&) const;
 
    TRGSignal& operator|=(const TRGSignal&);
 
    TRGSignal& operator|=(const TRGTime&);
 
    TRGSignal& widen(unsigned width);
 
    const TRGTime* operator[](unsigned i) const;
 
    bool operator==(const TRGSignal&) const;
 
    bool operator!=(const TRGSignal&) const;
 
  private:
 
    // /// And operation.
    // static std::vector<TRGTime> andOperation(const std::vector<TRGTime>&);
 
    static std::vector<TRGTime> orOperation(const std::vector<TRGTime>&);
 
    void sort(void);
 
    bool consistencyCheck(void) const;
 
  private:
 
    std::string _name;
 
    const TRGClock* _clock;
 
    std::vector<TRGTime> _history;
  };
 
//-----------------------------------------------------------------------------
 
  inline
  const std::string&
  TRGSignal::name(void) const
  {
    return _name;
  }
 
  inline
  const std::string&
  TRGSignal::name(const std::string& newName)
  {
    return _name = newName;
  }
 
  inline
  TRGSignal
  TRGSignal::operator&(const TRGTime& l) const
  {
    TRGSignal t(* this);
    TRGSignal left(l);
    return t & left;
  }
 
  inline
  TRGSignal&
  TRGSignal::operator&=(const TRGTime& l)
  {
    TRGSignal left(l);
 
#if TRG_DEBUG
    consistencyCheck();
#endif
 
    return (* this) &= left;
  }
 
  inline
  TRGSignal
  TRGSignal::operator|(const TRGTime& l) const
  {
    TRGSignal t(* this);
    TRGSignal left(l);
 
#if TRG_DEBUG
    consistencyCheck();
#endif
 
    return t | left;
  }
 
  inline
  TRGSignal&
  TRGSignal::operator|=(const TRGTime& l)
  {
    TRGSignal left(l);
 
#if TRG_DEBUG
    consistencyCheck();
#endif
 
    return (* this) |= left;
  }
 
  inline
  unsigned
  TRGSignal::nSignals(void) const
  {
    return _history.size() / 2;
  }
 
  inline
  unsigned
  TRGSignal::nEdges(void) const
  {
    return _history.size();
  }
 
  inline
  void
  TRGSignal::clear(void)
  {
 
#if TRG_DEBUG
    consistencyCheck();
#endif
 
    _history.clear();
  }
 
  inline
  bool
  TRGSignal::active(void) const
  {
    if (_history.size())
      return true;
    return false;
  }
 
  inline
  bool
  TRGSignal::state(int a) const
  {
    if (_history.size()) {
      bool last = false;
      for (unsigned i = 0; i < _history.size(); i++) {
        if (_history[i].time() <= a)
          last = _history[i].edge();
        else if (_history[i].time() > a)
          break;
      }
      return last;
    }
    return false;
 
  }
 
  inline
  bool
  TRGSignal::riseEdge(int a) const
  {
    if (_history.size()) {
      bool last = false;
      for (unsigned i = 0; i < _history.size(); i++) {
        if (_history[i].time() < a) {
          continue;
        } else if (_history[i].time() == a) {
          last = _history[i].edge();
        } else if (_history[i].time() > a) {
          break;
        }
      }
      return last;
    } else
      return false;
  }
 
  inline
  const TRGTime*
  TRGSignal::operator[](unsigned i) const
  {
    return & _history[i];
  }
 
  inline
  const TRGClock&
  TRGSignal::clock(void) const
  {
    return * _clock;
  }
 
  inline
  bool
  TRGSignal::operator!=(const TRGSignal& a) const
  {
    return (! operator==(a));
  }
 
  inline
  bool
  TRGSignal::active(int c0, int c1) const
  {
    for (unsigned i = 0; i < _history.size(); i++) {
      if (! _history[i].edge()) {
        const int t0 = _history[i - 1].time();
        const int t1 = _history[i].time();
 
        if ((c1 > t0) && (c0 < t1))
          return true;
        if ((c1 < t0) && (c1 < t1))
          return false;
      }
    }
    return false;
  }
 
} // namespace Belle2
 
#endif /* TRGSignal_FLAG_ */