MdtAmtReadOut.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MUONBYTESTREAM_MDTAMTREADOUT_H
#define MUONBYTESTREAM_MDTAMTREADOUT_H
 
#include <stdint.h>
 
#include "MdtReadOut.h"
 
// Decoding methods for MDT Amt raw data words
// S. Rosati Feb 2003
 
class MdtAmtReadOut : public MdtReadOut {
private:
    // Raw data word
    uint32_t m_dataWord;
    // Data word header
    uint16_t m_wordHeader;
 
    // Header info: event counter, bunch crossing ID and tdc number
    uint16_t m_tdcId;
    uint16_t m_ecnt;
    uint16_t m_bcId;
 
    // Footer info: words counter
    uint16_t m_wcnt;
 
    // Data info:
    uint16_t m_jt;
    uint16_t m_channel;
    uint16_t m_coarse;
    uint16_t m_fine;
    uint16_t m_width;
    bool m_errflag;
    uint16_t m_errstatus;
 
    uint32_t m_masked;
    bool m_leading;
 
    // Define the data structure and the word header values
 
    // Word header Position and values
    // The word header occupies the 4 highest bits of each TDC data word
    static constexpr uint16_t s_headerPos = 28;
    static constexpr uint16_t s_headerBits = 0xf;
 
    // Beginning of TDC: two possible header values
    // for channels 00-15 and 16-17 respectively
    static constexpr uint16_t s_BOTvalue1 = 0xa;
    static constexpr uint16_t s_BOTvalue2 = 0xb;
 
    // End of TDC
    static constexpr uint16_t s_EOTvalue = 0xc;
 
    // TDC single measurement
    static constexpr uint16_t s_TMCvalue = 0x2;
 
    // TDC single measurement
    static constexpr uint16_t s_TSMvalue = 0x3;
 
    // TDC combined measurement
    static constexpr uint16_t s_TCMvalue = 0x4;
 
    // TDC error status
    static constexpr uint16_t s_TESvalue = 0x6;
 
    // add the CSM trailer word count for operation with TDC trailer suppression
    static constexpr uint16_t s_TWCvalue = 0x8;
 
public:
    // Constructor and destructor
    MdtAmtReadOut();
    ~MdtAmtReadOut() = default;
 
    // Methods for decoding and encoding dataWords
    void decodeWord(uint32_t dataWord);
    void encodeWord(uint16_t headerVal);
 
    // Methods to identify the word type
    // Beginning of TDC
    bool is_BOT() { return ((m_wordHeader == s_BOTvalue1) || (m_wordHeader == s_BOTvalue2)); };
    // End of TDC
    bool is_EOT() { return (m_wordHeader == s_EOTvalue); };
    // TDC masked channels
    bool is_TMC() { return (m_wordHeader == s_TMCvalue); };
    // TDC single measurement
    bool is_TSM() { return (m_wordHeader == s_TSMvalue); };
    // TDC combined measurement
    bool is_TCM() { return (m_wordHeader == s_TCMvalue); };
    // TDC error status
    bool is_TES() { return (m_wordHeader == s_TESvalue); };
 
    // trailer word count (actually a CSM word)
    bool is_TWC() { return (m_wordHeader == s_TWCvalue); };
 
    // Methods to retrieve the decoded word content
    uint16_t tdcId() { return m_tdcId; }
    uint16_t ecnt() { return m_ecnt; }
    uint16_t bcId() { return m_bcId; }
 
    uint16_t jt() { return m_jt; }
    uint16_t channel() { return m_channel; }
    uint16_t coarse() { return m_coarse; }
    uint16_t fine() { return m_fine; }
    uint16_t width() { return m_width; }
    bool errflag() { return m_errflag; }
    uint16_t errstatus() { return m_errstatus; }
    uint32_t masked() { return m_masked; }
    bool isLeading() { return m_leading; }
 
    // Methods to encode data in 32 bits words
 
    uint32_t makeBOT(uint16_t tdcId, uint16_t ecnt, uint16_t bcid);
    uint32_t makeEOT(uint16_t jt, uint16_t ecnt, uint16_t wcnt);
    uint32_t makeTSM(uint16_t jt, uint16_t channel, bool leading, bool errflag, uint16_t coarse, uint16_t fine);
 
    uint32_t makeTCM(uint16_t jt, uint16_t channel, uint16_t width, uint16_t coarse, uint16_t fine);
 
    uint32_t makeTMC(uint16_t jt, uint32_t masked);
 
private:
    void setZero();
};
 
#endif  // MUONBYTESTREAM_MDTAMTREADOUT_H