HcalDTCHeader.h

Go to the documentation of this file.

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

#include <iostream>
#include <cstdint>
#include "DataFormats/HcalDigi/interface/HcalCalibrationEventTypes.h"
class HcalHTRData;

class HcalDTCHeader {
 public:
  static const int SLOT_COUNT;
  static const int MINIMUM_SLOT;
  static const int MAXIMUM_SLOT;

  HcalDTCHeader();

  unsigned int getTotalLengthBytes() const; 


  inline bool thereIsASecondCDFHeaderWord() const {return ((commondataformat0>>3) & 0x0001); }
  inline short getCDFversionNumber() const {return ((commondataformat0>>4) & 0x0F); }
  inline int getSourceId() const { return (commondataformat0>>8)&0xFFF; }
  inline int getBunchId() const { return (commondataformat0>>20)&0xFFF; }
  inline unsigned long getDTCEventNumber() const { return (commondataformat1 & 0x00FFFFFF); }
  inline unsigned short getCDFEventType() const { return ( (commondataformat1>>24) & 0x0F ); }
  inline unsigned short BOEshouldBe5Always() const { return ( (commondataformat1>>28) & 0x0F ); }


  inline bool thereIsAThirdCDFHeaderWord() const {return ((commondataformat2>>3) & 0x0001); }
  inline unsigned int getOrbitNumber() const { return ( ((commondataformat3 & 0xF) << 28) + ( commondataformat2>>4) ); }
  inline unsigned int getSlink64ReservedBits() const { return (  (commondataformat3>>4)&0x00FFFFFF ); }
  inline short BOEshouldBeZeroAlways() const { return ( (commondataformat3>>28) & 0x0F); }

  inline bool isCalibType() const { return ( 0 != getCalibType ());}
  inline HcalCalibrationEventType  getCalibType() const { return HcalCalibrationEventType ((commondataformat3>>24)&0x0000000F);}

  inline short getDTCDataFormatVersion() const { return (dcch0 & 0xFF); }
  inline int nSlotWords() const { return ((dcch0>>20)& 0x0000000F); }
  inline int nDTCWords() const { return ((dcch0>>8)& 0x00000FFF); }
  
  inline int getSlotSummary(int nslot) const { return slotInfo[nslot]; }

  int getSlotData(int nslot, HcalHTRData& decodeTool, int validSize) const;


  inline unsigned int getSlotDataLength(int nslot) const { return (nslot<1 || nslot>12)?(0):(slotInfo[nslot-1]&0xfff); }

  inline bool getSlotEnabled(unsigned int nslot) const { return (nslot<1 || nslot>12)?(false):(slotInfo[nslot-1]&0x8000); }
  inline bool getSlotPresent(unsigned int nslot) const { return (nslot<1 || nslot>12)?(false):(slotInfo[nslot-1]&0x4000); }
  inline bool getSlotValid(unsigned int nslot) const { return (nslot<1 || nslot>12)?(false):(slotInfo[nslot-1]&0x2000); }
  inline bool getSlotCRCError(unsigned int nslot) const { return (nslot<1 || nslot>12)?(false):(slotInfo[nslot-1]&0x1000); }

  /* (for packing only) */
  void copySlotData(unsigned int slot_id, const HcalHTRData& data, bool valid=true);

  void clear();
  void setHeader(int sourceid, int bcn, int l1aN, int orbN);

 private:
  // CURRENTLY VALID FOR LITTLE-ENDIAN (LINUX/x86) ONLY
  uint32_t commondataformat0;
  uint32_t commondataformat1;
  uint32_t commondataformat2;
  uint32_t commondataformat3;
  uint32_t dcch0;
  uint32_t dcch1;
  uint16_t slotInfo[12];

};

std::ostream& operator<<(std::ostream&, const HcalDTCHeader& head);

#endif