VFATFrame.h

Go to the documentation of this file.

/**********************************************************
*
* This is a part of the TOTEM offline software.
* Authors:
*    Jan Kaspar (jan.kaspar@gmail.com)
*
**********************************************************/

#ifndef EventFilter_CTPPSRawToDigi_VFATFrame
#define EventFilter_CTPPSRawToDigi_VFATFrame

#include <vector>
#include <cstddef>
#include <cstdint>

class VFATFrame {
public:
  typedef uint16_t word;

public:
  VFATFrame(const word* _data = nullptr);

  VFATFrame(const VFATFrame& copy) {
    setData(copy.data);
    presenceFlags = copy.presenceFlags;
    daqErrorFlags = copy.daqErrorFlags;
    numberOfClusters = copy.numberOfClusters;
  }

  virtual ~VFATFrame() {}

  void setData(const word* _data);

  VFATFrame::word* getData() { return data; }

  const VFATFrame::word* getData() const { return data; }

  VFATFrame::word getBC() const { return data[11] & 0x0FFF; }

  VFATFrame::word getEC() const { return (data[10] & 0x0FF0) >> 4; }

  VFATFrame::word getFlags() const { return data[10] & 0x000F; }

  VFATFrame::word getChipID() const { return data[9] & 0x0FFF; }

  VFATFrame::word getCRC() const { return data[0]; }

  VFATFrame::word getCRCT2() const { return data[11]; }

  void setPresenceFlags(uint8_t v) { presenceFlags = v; }

  bool isBCPresent() const { return presenceFlags & 0x1; }

  bool isECPresent() const { return presenceFlags & 0x2; }

  bool isIDPresent() const { return presenceFlags & 0x4; }

  bool isCRCPresent() const { return presenceFlags & 0x8; }

  bool isNumberOfClustersPresent() const { return presenceFlags & 0x10; }

  void setDAQErrorFlags(uint8_t v) { daqErrorFlags = v; }

  void setNumberOfClusters(uint8_t v) { numberOfClusters = v; }

  uint8_t getNumberOfClusters() const { return numberOfClusters; }

  bool checkFootprint() const;

  bool checkFootprintT2() const;

  virtual bool checkCRC() const;

  virtual bool checkCRCT2() const;

  virtual bool channelActive(unsigned char channel) const {
    return (data[1 + (channel / 16)] & (1 << (channel % 16))) ? true : false;
  }

  virtual std::vector<unsigned char> getActiveChannels() const;

  void Print(bool binary = false) const;

  //Follow the VFAT2 manual format, not reversed
  void PrintT2(bool binary = false) const;

  static word calculateCRC(word crc_in, word dato);

protected:
  word data[12];

private:
  uint8_t presenceFlags;

  uint8_t daqErrorFlags;

  uint8_t numberOfClusters;
};

#endif