ETLSample.h

Go to the documentation of this file.

#ifndef DIGIFTL_ETLSAMPLE_H
#define DIGIFTL_ETLSAMPLE_H

#include <iostream>
#include <ostream>
#include <cstdint>

class ETLSample {
public:
  enum ETLSampleMasks {
    kThreshMask = 0x1,
    kModeMask = 0x1,
    kColumnMask = 0x1f,
    kRowMask = 0x3f,
    kToAMask = 0x7ff,
    kDataMask = 0xff,
    kToTMask = 0x7ff
  };
  enum ETLSampleShifts {
    kThreshShift = 31,
    kModeShift = 30,
    kColumnShift = 25,
    kRowShift = 19,
    kToAShift = 8,
    kDataShift = 0,
    kToTShift = 0
  };

  ETLSample() : value_(0), valueToT_(0) {}
  ETLSample(uint32_t value) : value_(value), valueToT_(0) {}
  ETLSample(uint32_t value, uint32_t valueToT) : value_(value), valueToT_(valueToT) {}
  ETLSample(const ETLSample& o) : value_(o.value_), valueToT_(o.valueToT_) {}
  ETLSample& operator=(const ETLSample&) = default;

  void setThreshold(bool thr) { setWord(thr, kThreshMask, kThreshShift); }
  void setMode(bool mode) { setWord(mode, kModeMask, kModeShift); }
  void setColumn(uint8_t col) { setWord(col, kColumnMask, kColumnShift); }
  void setRow(uint8_t row) { setWord(row, kRowMask, kRowShift); }
  void setToA(uint16_t toa) { setWord(toa, kToAMask, kToAShift); }
  void setToT(uint16_t tot) { setWordToT(tot, kToTMask, kToTShift); }
  void setData(uint16_t data) { setWord(data, kDataMask, kDataShift); }
  void set(bool thr, bool mode, uint16_t toa, uint16_t tot, uint16_t data, uint8_t row, uint8_t col) {
    value_ = (((uint32_t)thr & kThreshMask) << kThreshShift | ((uint32_t)mode & kModeMask) << kModeShift |
              ((uint32_t)col & kColumnMask) << kColumnShift | ((uint32_t)row & kRowMask) << kRowShift |
              ((uint32_t)toa & kToAMask) << kToAShift | ((uint32_t)data & kDataMask) << kDataShift);
    valueToT_ = ((uint32_t)tot & kToTMask) << kToTShift;
  }
  void print(std::ostream& out = std::cout) {
    out << "(row,col) : (" << row() << ',' << column() << ") "
        << "THR: " << threshold() << " Mode: " << mode() << " ToA: " << toa() << " ToT: " << tot()
        << " Data: " << data() << " Raw=0x" << std::hex << raw() << std::dec << std::endl;
  }

  uint32_t raw() const { return value_; }
  bool threshold() const { return ((value_ >> kThreshShift) & kThreshMask); }
  bool mode() const { return ((value_ >> kModeShift) & kModeMask); }
  uint32_t column() const { return ((value_ >> kColumnShift) & kColumnMask); }
  uint32_t row() const { return ((value_ >> kRowShift) & kRowMask); }
  uint32_t toa() const { return ((value_ >> kToAShift) & kToAMask); }
  uint32_t tot() const { return ((valueToT_ >> kToTShift) & kToTMask); }
  uint32_t data() const { return ((value_ >> kDataShift) & kDataMask); }
  uint32_t operator()() { return value_; }

private:
  void setWord(uint32_t word, uint32_t mask, uint32_t pos) {
    //clear required bits
    value_ &= ~(mask << pos);
    //now set the new value
    value_ |= ((word & mask) << pos);
  }

  void setWordToT(uint32_t word, uint32_t mask, uint32_t pos) {
    //clear required bits
    valueToT_ &= ~(mask << pos);
    //now set the new value
    valueToT_ |= ((word & mask) << pos);
  }

  // a 32-bit word
  uint32_t value_;
  uint32_t valueToT_;
};

#endif