HGCSample Class Reference

wrapper for a data word More...

#include <HGCSample.h>

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

Public Member Functions
uint32_t	data () const
bool	getToAValid () const
	HGCSample ()
	CTOR. More...
	HGCSample (uint32_t value)
	HGCSample (const HGCSample &o)
bool	mode () const
uint32_t	operator() ()
void	print (std::ostream &out=std::cout)
uint32_t	raw () const
	getters More...
void	set (bool thr, bool mode, uint16_t toa, uint16_t data)
void	setData (uint16_t data)
void	setMode (bool mode)
void	setThreshold (bool thr)
	setters More...
void	setToA (uint16_t toa)
void	setToAValid (bool toaFired)
bool	threshold () const
uint32_t	toa () const

Private Member Functions
void	setWord (uint32_t word, uint32_t mask, uint32_t pos)
	wrapper to reset words at a given position More...

Private Attributes
bool	toaFired_
uint32_t	value_

Detailed Description

wrapper for a data word

Definition at line 13 of file HGCSample.h.

Member Enumeration Documentation

enum HGCSample::HGCSampleMasks

Enumerator
kThreshMask
kModeMask
kToAMask
kDataMask

Definition at line 17 of file HGCSample.h.

{ kThreshMask = 0x1, kModeMask = 0x1, kToAMask = 0x3ff, kDataMask = 0xfff};

enum HGCSample::HGCSampleShifts

Enumerator
kThreshShift
kModeShift
kToAShift
kDataShift

Definition at line 18 of file HGCSample.h.

{ kThreshShift = 31, kModeShift = 30, kToAShift = 13,   kDataShift = 0};

Constructor & Destructor Documentation

HGCSample::HGCSample ( )

inline

CTOR.

Definition at line 23 of file HGCSample.h.

: value_(0), toaFired_(false) { }

HGCSample::HGCSample ( uint32_t  value )

inline

Definition at line 24 of file HGCSample.h.

: value_(value), toaFired_(false) { }

HGCSample::HGCSample ( const HGCSample &  o )

inline

Definition at line 25 of file HGCSample.h.

: value_(o.value_), toaFired_(o.toaFired_) { }

Member Function Documentation

uint32_t HGCSample::data ( ) const

inline

Definition at line 62 of file HGCSample.h.

References kDataMask, kDataShift, and value_.

Referenced by HGCalDigiValidation::analyze(), HGCalTBAnalyzer::analyze(), print(), and set().

{ return ( (value_ >> kDataShift)   & kDataMask   ); }

bool HGCSample::getToAValid ( ) const

inline

Definition at line 60 of file HGCSample.h.

References toaFired_.

{ return toaFired_;                }

bool HGCSample::mode ( ) const

inline

Definition at line 59 of file HGCSample.h.

References kModeMask, kModeShift, and value_.

Referenced by print().

{ return ( (value_ >> kModeShift)   & kModeMask   );  }

uint32_t HGCSample::operator() ( )

inline

Definition at line 63 of file HGCSample.h.

References value_.

{ return value_;                   }

void HGCSample::print ( std::ostream &  out = std::cout )

inline

Definition at line 45 of file HGCSample.h.

References data(), TauDecayModes::dec, mode(), MillePedeFileConverter_cfg::out, raw(), threshold(), and toa().

  {
    out << "THR: " << threshold() 
    << " Mode: " << mode() 
    << " ToA: " << toa() 
    << " Data: " << data() 
    << " Raw=0x" << std::hex << raw() << std::dec << std::endl;  
  }

uint32_t HGCSample::raw ( ) const

inline

getters

Definition at line 57 of file HGCSample.h.

References value_.

Referenced by print().

{ return value_;                   }

void HGCSample::set ( bool  thr, bool  mode, uint16_t  toa, uint16_t  data  )

inline

Definition at line 35 of file HGCSample.h.

References data(), kDataMask, kDataShift, kModeMask, kModeShift, kThreshMask, kThreshShift, kToAMask, kToAShift, toa(), and value_.

Referenced by HGCFEElectronics< DFr >::runShaperWithToT(), HGCFEElectronics< DFr >::runSimpleShaper(), and HGCFEElectronics< DFr >::runTrivialShaper().

  { 
    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 HGCSample::setData ( uint16_t  data )

inline

Definition at line 34 of file HGCSample.h.

References kDataMask, kDataShift, and setWord().

{ setWord(data, kDataMask,   kDataShift);   }

void HGCSample::setMode ( bool  mode )

inline

Definition at line 31 of file HGCSample.h.

References kModeMask, kModeShift, and setWord().

{ setWord(mode, kModeMask,   kModeShift);   }

void HGCSample::setThreshold ( bool  thr )

inline

setters

Definition at line 30 of file HGCSample.h.

References kThreshMask, kThreshShift, and setWord().

{ setWord(thr,  kThreshMask, kThreshShift); }

void HGCSample::setToA ( uint16_t  toa )

inline

Definition at line 32 of file HGCSample.h.

References kToAMask, kToAShift, and setWord().

{ setWord(toa,  kToAMask,    kToAShift);    }

void HGCSample::setToAValid ( bool  toaFired )

inline

Definition at line 33 of file HGCSample.h.

References toaFired_.

Referenced by HGCFEElectronics< DFr >::runShaperWithToT().

{ toaFired_ = toaFired;  }

void HGCSample::setWord ( uint32_t  word, uint32_t  mask, uint32_t  pos  )

inlineprivate

wrapper to reset words at a given position

Definition at line 70 of file HGCSample.h.

References RecoTauDiscriminantConfiguration::mask, and value_.

Referenced by setData(), setMode(), setThreshold(), and setToA().

  {
    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);
  }

bool HGCSample::threshold ( ) const

inline

Definition at line 58 of file HGCSample.h.

References kThreshMask, kThreshShift, and value_.

Referenced by print().

{ return ( (value_ >> kThreshShift) & kThreshMask );  }

uint32_t HGCSample::toa ( ) const

inline

Definition at line 61 of file HGCSample.h.

References kToAMask, kToAShift, and value_.

Referenced by HGCalDigiValidation::analyze(), print(), and set().

{ return ( (value_ >> kToAShift)    & kToAMask    ); }

Member Data Documentation

bool HGCSample::toaFired_

private

Definition at line 82 of file HGCSample.h.

Referenced by getToAValid(), and setToAValid().

uint32_t HGCSample::value_

private

Definition at line 81 of file HGCSample.h.

Referenced by data(), mode(), operator()(), raw(), set(), setWord(), threshold(), and toa().