HcalUHTRData.h

Go to the documentation of this file.

/* -*- C++ -*- */
#ifndef HcalUHTRData_H
#define HcalUHTRData_H

#include <stdint.h>

class HcalUHTRData {
 public:
  static const int FIBERS_PER_UHTR             = 24;
  static const int CHANNELS_PER_FIBER_HF       = 4;
  static const int CHANNELS_PER_FIBER_HBHE     = 6;
  static const int CHANNELS_PER_FIBER_MAX      = 8;
  
  HcalUHTRData();
  ~HcalUHTRData() { if (m_ownData!=0) delete [] m_ownData; }
  HcalUHTRData(int version_to_create);
  HcalUHTRData(const uint64_t* data, int length_words);
  HcalUHTRData(const HcalUHTRData&);
  
  HcalUHTRData& operator=(const HcalUHTRData&);
  
  inline int getFormatVersion() const { return m_formatVersion; }
  
  inline const unsigned short* getRawData16() const { return m_raw16; }
  
  inline const int getRawLengthBytes() const { return m_rawLength64*sizeof(uint64_t); }
  
  class const_iterator {
  public:
    const_iterator(const uint16_t* ptr, const uint16_t* limit=0);
    
    bool isHeader() const { return ((*m_ptr)&0x8000)!=0; }    
    int flavor() const { return ((*m_ptr)>>12)&0x7; }    
    int errFlags() const { return ((*m_ptr)>>10)&0x3; }    
    int capid0() const { return ((*m_ptr)>>8)&0x3; }    
    int channelid() const { return ((*m_ptr))&0xFF; }    

    uint16_t value() const { return *m_ptr; }

    uint8_t adc() const;
    uint8_t le_tdc() const;
    uint8_t te_tdc() const;
    bool soi() const;
    uint8_t capid() const;
    bool ok() const;

    uint16_t operator*() const { return *m_ptr; }

    const_iterator& operator++();

    bool operator==(const const_iterator& i) { return m_ptr==i.m_ptr; }
    bool operator!=(const const_iterator& i) { return m_ptr!=i.m_ptr; }
    const uint16_t* raw() const { return m_ptr; }

  private:
    void determineMode();
    const uint16_t* m_ptr, *m_limit;
    const uint16_t* m_header_ptr, *m_0th_data_ptr;
    int m_microstep;
    int m_stepclass;
    int m_flavor;
  };    

  const_iterator begin() const;
  const_iterator end() const;

  class packer {
  public:
    packer(uint16_t* baseptr);
    void addHeader(int flavor, int errf, int cap0, int channelid);
    void addSample(int adc, bool soi=false, int retdc=0, int fetdc=0, int tdcstat=0);
    void addTP(int tpword, bool soi=false);
  private:
    uint16_t* m_baseptr;
    int m_ptr;
    int m_flavor;
    int m_ministep;
  };

  packer pack();


  void packHeaderTrailer(int L1Anumber, int bcn, int submodule, int
             orbitn, int pipeline, int ndd, int nps, int firmwareRev=0);

  void packUnsuppressed(const bool* mp);
    
  inline uint32_t l1ANumber() const {  return uint32_t(m_raw64[0]>>32)&0xFFFFFF; }
  inline uint32_t bunchNumber() const { return uint32_t(m_raw64[0]>>20)&0xFFF; }
  inline uint32_t orbitNumber() const { return uint32_t(m_raw64[1]>>16)&0xFFFF; }
  int getEventType() const { return uint32_t(m_raw64[1]>>40)&0xF; }
  inline uint32_t boardId() const { return uint32_t(m_raw64[1])&0xFFFF; }
  inline uint32_t crateId() const { return uint32_t(m_raw64[1])&0xFF; }
  inline uint32_t slot() const { return uint32_t(m_raw64[1]>>8)&0xF; }
  inline uint32_t presamples() const { return uint32_t((m_raw64[1]&~0x8000)>>12)&0xF; }

  bool wasMarkAndPassZS(int fiber, int fiberchan) const;
  bool wasMarkAndPassZSTP(int slb, int slbchan) const;
  
  unsigned int getFirmwareRevision() const { return uint32_t(m_raw64[1]>>48)&0xFFFF; }
  int getFirmwareFlavor() const { return uint32_t(m_raw64[1]>>32)&0xFF; }

  //** \brief Check for simulated HTR with flag word kept */
  bool wasSimulatedHTR() const { return (((m_raw64[1]&0x8000)>>15)&0x1)==1; }

protected:
  int m_formatVersion;
  int m_rawLength64;
  const uint64_t* m_raw64;
  const uint16_t* m_raw16;
  uint64_t* m_ownData;
};

#endif