HGCSample.h

Go to the documentation of this file.

#ifndef DIGIHGCAL_HGCSAMPLE_H
#define DIGIHGCAL_HGCSAMPLE_H

#include <iostream>
#include <ostream>
#include <boost/cstdint.hpp>

class HGCSample {

public:

  enum HGCSampleMasks { kThreshMask = 0x1, kModeMask = 0x1, kToAMask = 0x3ff, kDataMask = 0xfff};
  enum HGCSampleShifts{ kThreshShift = 31, kModeShift = 30, kToAShift = 13,   kDataShift = 0};

 HGCSample() : value_(0), toaFired_(false) { }
 HGCSample(uint32_t value) : value_(value), toaFired_(false) { }
 HGCSample( const HGCSample& o ) : value_(o.value_), toaFired_(o.toaFired_) { }

  void setThreshold(bool thr)           { setWord(thr,  kThreshMask, kThreshShift); }
  void setMode(bool mode)               { setWord(mode, kModeMask,   kModeShift);   }
  void setToA(uint16_t toa)             { setWord(toa,  kToAMask,    kToAShift);    }
  void setToAValid(bool toaFired)       { toaFired_ = toaFired;  }
  void setData(uint16_t data)           { setWord(data, kDataMask,   kDataShift);   }
  void set(bool thr, bool mode,uint16_t toa, uint16_t data) 
  { 
    toa = ( toa > kToAMask ? kToAMask : toa );
    data = ( data > kDataMask ? kDataMask : data);

    value_ = ( ( (uint32_t)thr  & kThreshMask ) << kThreshShift | 
               ( (uint32_t)mode & kModeMask   ) << kModeShift   |
               ( (uint32_t)toa  & kToAMask    ) << kToAShift    | 
               ( (uint32_t)data & kDataMask   ) << kDataShift     );    
  }  
  void print(std::ostream &out=std::cout)
  {
    out << "THR: " << threshold() 
    << " Mode: " << mode() 
    << " ToA: " << toa() 
    << " Data: " << data() 
    << " Raw=0x" << std::hex << raw() << std::dec << std::endl;  
  }

  uint32_t raw()  const      { return value_;                   }
  bool threshold() const     { return ( (value_ >> kThreshShift) & kThreshMask );  }
  bool mode() const          { return ( (value_ >> kModeShift)   & kModeMask   );  }
  bool getToAValid() const   { return toaFired_;                }
  uint32_t toa()  const      { return ( (value_ >> kToAShift)    & kToAMask    ); }
  uint32_t data()  const     { return ( (value_ >> kDataShift)   & kDataMask   ); }
  uint32_t operator()()      { return value_;                   }
  
private:

  void setWord(uint32_t word, uint32_t mask, uint32_t pos)
  {
    if( word > mask ) word = mask; // deal with saturation
    //clear required bits
    const uint32_t masked_word = (word & mask) << pos;
    value_ &= ~(masked_word); 
    //now set the new value
    value_ |= (masked_word);
  }

  // a 32-bit word
  uint32_t value_;
  bool toaFired_;
};

  
#endif