BTLSample Class Reference

wrapper for a data word More...

#include <BTLSample.h>

Public Types
enum	BTLSampleDataMasks { kToA2Mask = 0x3ff, kToAMask = 0x3ff, kDataMask = 0x3ff }
enum	BTLSampleDataShifts { kToA2Shift = 20, kToAShift = 10, kDataShift = 0 }
enum	BTLSampleFlagMasks { kThreshMask = 0x1, kModeMask = 0x1 }
enum	BTLSampleFlagShifts { kThreshShift = 1, kModeShift = 0 }

Public Member Functions
	BTLSample ()
	CTOR. More...
	BTLSample (uint32_t value, uint16_t flag, uint8_t row, uint8_t col)
	BTLSample (const BTLSample &o)
uint8_t	column () const
uint32_t	data () const
bool	mode () const
void	print (std::ostream &out=std::cout)
uint32_t	raw_data () const
	getters More...
uint16_t	raw_flag () const
uint8_t	row () const
void	set (bool thr, bool mode, uint16_t toa2, uint16_t toa, uint16_t data, uint8_t row, uint8_t col)
void	setData (uint16_t data)
void	setMode (bool mode)
void	setThreshold (bool thr)
	setters More...
void	setToA (uint16_t toa)
void	setToA2 (uint16_t toa2)
bool	threshold () const
uint32_t	toa () const
uint32_t	toa2 () const

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

Private Attributes
uint8_t	col_
uint16_t	flag_
uint8_t	row_
uint32_t	value_

Detailed Description

wrapper for a data word

Definition at line 13 of file BTLSample.h.

Member Enumeration Documentation

enum BTLSample::BTLSampleDataMasks

Enumerator
kToA2Mask
kToAMask
kDataMask

Definition at line 15 of file BTLSample.h.

{ kToA2Mask = 0x3ff, kToAMask = 0x3ff, kDataMask = 0x3ff };

enum BTLSample::BTLSampleDataShifts

Enumerator
kToA2Shift
kToAShift
kDataShift

Definition at line 16 of file BTLSample.h.

{ kToA2Shift = 20, kToAShift = 10, kDataShift = 0 };

enum BTLSample::BTLSampleFlagMasks

Enumerator
kThreshMask
kModeMask

Definition at line 18 of file BTLSample.h.

{ kThreshMask = 0x1, kModeMask = 0x1 };

enum BTLSample::BTLSampleFlagShifts

Enumerator
kThreshShift
kModeShift

Definition at line 19 of file BTLSample.h.

{ kThreshShift = 1, kModeShift = 0 };

Constructor & Destructor Documentation

BTLSample::BTLSample ( )

inline

CTOR.

Definition at line 24 of file BTLSample.h.

: value_(0), flag_(0), row_(0), col_(0) {}

BTLSample::BTLSample ( uint32_t  value, uint16_t  flag, uint8_t  row, uint8_t  col  )

inline

Definition at line 25 of file BTLSample.h.

      : value_(value), flag_(flag), row_(row), col_(col) {}

BTLSample::BTLSample ( const BTLSample &  o )

inline

Definition at line 27 of file BTLSample.h.

: value_(o.value_), flag_(o.flag_), row_(o.row_), col_(o.col_) {}

Member Function Documentation

uint8_t BTLSample::column ( ) const

inline

Definition at line 62 of file BTLSample.h.

References col_.

Referenced by print().

{ return col_; }

uint32_t BTLSample::data ( ) const

inline

Definition at line 60 of file BTLSample.h.

References kDataMask, kDataShift, and value_.

Referenced by print().

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

bool BTLSample::mode ( ) const

inline

Definition at line 57 of file BTLSample.h.

References flag_, kModeMask, and kModeShift.

Referenced by print().

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

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

inline

Definition at line 45 of file BTLSample.h.

References column(), data(), TauDecayModes::dec, mode(), submitPVResolutionJobs::out, raw_data(), raw_flag(), row(), threshold(), toa(), and toa2().

                                        {
    out << "THR: " << threshold() << " Mode: " << mode() << " ToA2: " << toa2() << " ToA: " << toa()
        << " Data: " << data() << " Row: " << (uint32_t)row() << " Column: " << (uint32_t)column() << " Raw Flag=0x"
        << std::hex << raw_flag() << std::dec << " Raw Data=0x" << std::hex << raw_data() << std::dec << std::endl;
  }

uint32_t BTLSample::raw_data ( ) const

inline

getters

Definition at line 54 of file BTLSample.h.

References value_.

Referenced by print().

{ return value_; }

uint16_t BTLSample::raw_flag ( ) const

inline

Definition at line 55 of file BTLSample.h.

References flag_.

Referenced by print().

{ return flag_; }

uint8_t BTLSample::row ( ) const

inline

Definition at line 61 of file BTLSample.h.

References row_.

Referenced by print(), and set().

{ return row_; }

void BTLSample::set ( bool  thr, bool  mode, uint16_t  toa2, uint16_t  toa, uint16_t  data, uint8_t  row, uint8_t  col  )

inline

Definition at line 37 of file BTLSample.h.

References cuy::col, col_, flag_, kDataMask, kDataShift, kModeMask, kModeShift, kThreshMask, kThreshShift, kToA2Mask, kToA2Shift, kToAMask, kToAShift, row(), row_, and value_.

Referenced by BTLElectronicsSim::runTrivialShaper().

                                                                                                      {
    flag_ = (((uint16_t)thr & kThreshMask) << kThreshShift | ((uint16_t)mode & kModeMask) << kModeShift);

    value_ = (((uint32_t)toa2 & kToA2Mask) << kToA2Shift | ((uint32_t)toa & kToAMask) << kToAShift |
              ((uint32_t)data & kDataMask) << kDataShift);
    row_ = row;
    col_ = col;
  }

void BTLSample::setData ( uint16_t  data )

inline

Definition at line 36 of file BTLSample.h.

References kDataMask, kDataShift, and setDataWord().

{ setDataWord(data, kDataMask, kDataShift); }

void BTLSample::setDataWord ( uint32_t  word, uint32_t  mask, uint32_t  pos  )

inlineprivate

wrapper to reset words at a given position

Definition at line 68 of file BTLSample.h.

References value_.

Referenced by setData(), setToA(), and setToA2().

                                                               {
    //clear required bits
    value_ &= ~(mask << pos);
    //now set the new value
    value_ |= ((word & mask) << pos);
  }

void BTLSample::setFlagWord ( uint16_t  word, uint16_t  mask, uint16_t  pos  )

inlineprivate

Definition at line 74 of file BTLSample.h.

References flag_.

Referenced by setMode(), and setThreshold().

                                                               {
    //clear required bits
    flag_ &= ~(mask << pos);
    //now set the new value
    flag_ |= ((word & mask) << pos);
  }

void BTLSample::setMode ( bool  mode )

inline

Definition at line 33 of file BTLSample.h.

References kModeMask, kModeShift, and setFlagWord().

{ setFlagWord(mode, kModeMask, kModeShift); }

void BTLSample::setThreshold ( bool  thr )

inline

setters

Definition at line 32 of file BTLSample.h.

References kThreshMask, kThreshShift, and setFlagWord().

{ setFlagWord(thr, kThreshMask, kThreshShift); }

void BTLSample::setToA ( uint16_t  toa )

inline

Definition at line 34 of file BTLSample.h.

References kToAMask, kToAShift, and setDataWord().

{ setDataWord(toa, kToAMask, kToAShift); }

void BTLSample::setToA2 ( uint16_t  toa2 )

inline

Definition at line 35 of file BTLSample.h.

References kToA2Mask, kToA2Shift, and setDataWord().

{ setDataWord(toa2, kToA2Mask, kToA2Shift); }

bool BTLSample::threshold ( ) const

inline

Definition at line 56 of file BTLSample.h.

References flag_, kThreshMask, and kThreshShift.

Referenced by print().

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

uint32_t BTLSample::toa ( ) const

inline

Definition at line 58 of file BTLSample.h.

References kToAMask, kToAShift, and value_.

Referenced by print().

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

uint32_t BTLSample::toa2 ( ) const

inline

Definition at line 59 of file BTLSample.h.

References kToA2Mask, kToA2Shift, and value_.

Referenced by print().

{ return ((value_ >> kToA2Shift) & kToA2Mask); }

Member Data Documentation

uint8_t BTLSample::col_

private

Definition at line 84 of file BTLSample.h.

Referenced by column(), and set().

uint16_t BTLSample::flag_

private

Definition at line 83 of file BTLSample.h.

Referenced by mode(), raw_flag(), set(), setFlagWord(), and threshold().

uint8_t BTLSample::row_

private

Definition at line 84 of file BTLSample.h.

Referenced by row(), and set().

uint32_t BTLSample::value_

private

Definition at line 82 of file BTLSample.h.

Referenced by data(), raw_data(), set(), setDataWord(), toa(), and toa2().