HcalHTRData.h

Go to the documentation of this file.

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

#include <stdint.h>

class HcalHTRData {
 public:
  static const int CHANNELS_PER_SPIGOT         = 24;
  static const int MAXIMUM_SAMPLES_PER_CHANNEL = 20;
  static const int FORMAT_VERSION_COMPACT_DATA =  6;
  
  HcalHTRData();
  ~HcalHTRData() { if (m_ownData!=0) delete [] m_ownData; }
  HcalHTRData(int version_to_create);
  HcalHTRData(const unsigned short* data, int length);
  HcalHTRData(const HcalHTRData&);
  
  HcalHTRData& operator=(const HcalHTRData&);
  void allocate(int version_to_create=0);
  void adoptData(const unsigned short* data, int length);
  
  inline int getFormatVersion() const { return m_formatVersion; }
  
  inline const unsigned short* getRawData() const { return m_rawConst; }
  
  inline const int getRawLength() const { return m_rawLength; }
  
  bool check() const;

  bool isEmptyEvent() const;
  bool isOverflowWarning() const;
  bool isBusy() const;

  
  void dataPointers(const unsigned short** daq_first,
            const unsigned short** daq_last,
            const unsigned short** tp_first,
            const unsigned short** tp_last) const;
  
  
  void unpack(unsigned char* daq_lengths, unsigned short* daq_samples,
          unsigned char* tp_lengths, unsigned short* tp_samples) const;
  
  bool unpackHistogram(int fiber, int fiberchan, int capid, unsigned
               short* histogram) const;

  static bool unpack_per_channel_header(unsigned short, int& flav, int& error_flags, int& capid0, int& channelid);
  
  static bool is_channel_header(unsigned short value) { return (value&0x8000)!=0; }

  void pack(unsigned char* daq_lengths, unsigned short* daq_samples,
        unsigned char* tp_lengths, unsigned short* tp_samples, bool
        do_capid=false);
  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 unsigned int getL1ANumber() const { 
    return (m_rawConst[0]&0xFF)+(m_rawConst[1]<<8); 
  }
  inline unsigned int getBunchNumber() const { 
    return (m_rawConst[4]&0xFFF); 
  }
  unsigned int getOrbitNumber() const;
  unsigned int getSubmodule() const;
  // get the htr slot
  unsigned int htrSlot() const;
  // get the htr top/bottom (1=top/0=bottom)
  unsigned int htrTopBottom() const;
  // get the readout VME crate number
  unsigned int readoutVMECrateId() const;
  bool isCalibrationStream() const;
  bool isUnsuppressed() const;
  bool wasMarkAndPassZS(int fiber, int fiberchan) const;
  bool wasMarkAndPassZSTP(int slb, int slbchan) const;
  uint32_t zsBunchMask() const;
  
  bool isPatternRAMEvent() const;
  bool isHistogramEvent() const;
  void getHistogramFibers(int& a, int& b) const;
  unsigned int getPipelineLength() const;
  unsigned int getFirmwareRevision() const;
  int getFirmwareFlavor() const;
  inline unsigned int getErrorsWord() const { 
    return m_rawConst[2]&0xFFFF; }
  int getNPrecisionWords() const;
  int getNDD() const;
  int getNTP() const;
  int getNPS() const;

  inline unsigned int getDLLunlock() const { 
    return (m_rawConst[5]>>1)&0x3; }

  inline unsigned int getTTCready() const { 
    return m_rawConst[5]&0x1; }

  inline unsigned int getFibOrbMsgBCN(int fiber) const {
    return (m_formatVersion==-1 || fiber<1 || fiber>8)?(0):(m_rawConst[m_rawLength-12+(fiber-1)]&0xFFF);
  }

  inline unsigned int getFib1OrbMsgBCN() const {
  return (m_formatVersion==-1)?(0):(m_rawConst[m_rawLength-12]&0xFFF);
}
  inline unsigned int getFib2OrbMsgBCN() const {
  return (m_formatVersion==-1)?(0):(m_rawConst[m_rawLength-11]&0xFFF);
}

  inline unsigned int getFib3OrbMsgBCN() const {
  return (m_formatVersion==-1)?(0):(m_rawConst[m_rawLength-10]&0xFFF);
}

  inline unsigned int getFib4OrbMsgBCN() const {
  return (m_formatVersion==-1)?(0):(m_rawConst[m_rawLength-9]&0xFFF);
}

  inline unsigned int getFib5OrbMsgBCN() const {
  return (m_formatVersion==-1)?(0):(m_rawConst[m_rawLength-8]&0xFFF);
}

  inline unsigned int getFib6OrbMsgBCN() const {
  return (m_formatVersion==-1)?(0):(m_rawConst[m_rawLength-7]&0xFFF);
}

  inline unsigned int getFib7OrbMsgBCN() const {
  return (m_formatVersion==-1)?(0):(m_rawConst[m_rawLength-6]&0xFFF);
}

  inline unsigned int getFib8OrbMsgBCN() const {
  return (m_formatVersion==-1)?(0):(m_rawConst[m_rawLength-5]&0xFFF);
}



  inline unsigned int getExtHdr1() const { 
    return (m_rawConst[0]);}
  inline unsigned int getExtHdr2() const { 
    return (m_rawConst[1]); }
  inline unsigned int getExtHdr3() const { 
    return (m_rawConst[2]);} 
  inline unsigned int getExtHdr4() const { 
    return (m_rawConst[3]); }
  inline unsigned int getExtHdr5() const { 
    return (m_rawConst[4]);} 
  inline unsigned int getExtHdr6() const { 
    return (m_rawConst[5]);} 
  inline unsigned int getExtHdr7() const { 
    return (m_rawConst[6]);} 
  inline unsigned int getExtHdr8() const { 
    return (m_rawConst[7]);}  

  /* unsigned int getFib1OrbMsgBCN() const;
  unsigned int getFib2OrbMsgBCN() const;
  unsigned int getFib3OrbMsgBCN() const;
  unsigned int getFib4OrbMsgBCN() const;
  unsigned int getFib5OrbMsgBCN() const;
  unsigned int getFib6OrbMsgBCN() const;
  unsigned int getFib7OrbMsgBCN() const;
  unsigned int getFib8OrbMsgBCN() const;
  */

  bool wasHistogramError(int ifiber) const;
  
protected:
  void determineSectionLengths(int& tpWords, int& daqWords, int&
                   headerWords, int& trailerWords) const;
  void determineStaticLengths(int& headerWords, int& trailerWords) const;
  int m_formatVersion;
  int m_rawLength;
  const unsigned short* m_rawConst;
  unsigned short* m_ownData;
};

#endif