HGCSample Class Reference

wrapper for a data word More...

#include <HGCSample.h>

Public Types
enum	HGCSampleMasks { ADC_MASK =0x7fff, GAIN_MASK =0x1 }
enum	HGCSamplePos { ADC_POS =0, GAIN_POS =15 }

Public Member Functions
uint16_t	adc () const
uint16_t	gain () const
	HGCSample ()
	CTOR. More...
	HGCSample (uint16_t value)
uint16_t	operator() ()
uint16_t	raw () const
	getters More...
void	set (uint16_t gain, uint16_t adc)
void	setADC (uint16_t adc)
void	setGain (uint16_t gain)
	setters More...

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

Private Attributes
uint16_t	value_

Detailed Description

wrapper for a data word

Definition at line 12 of file HGCSample.h.

Member Enumeration Documentation

enum HGCSample::HGCSampleMasks

Enumerator
ADC_MASK
GAIN_MASK

Definition at line 16 of file HGCSample.h.

{ADC_MASK=0x7fff, GAIN_MASK=0x1 };

enum HGCSample::HGCSamplePos

Enumerator
ADC_POS
GAIN_POS

Definition at line 17 of file HGCSample.h.

{ADC_POS=0      , GAIN_POS=15 };

Constructor & Destructor Documentation

HGCSample::HGCSample ( )

inline

CTOR.

Definition at line 22 of file HGCSample.h.

: value_(0) { }

HGCSample::HGCSample ( uint16_t  value )

inline

Definition at line 23 of file HGCSample.h.

: value_(value) { }

Member Function Documentation

uint16_t HGCSample::adc ( ) const

inline

Definition at line 37 of file HGCSample.h.

References ADC_MASK, ADC_POS, and value_.

{ return ((value_ >> ADC_POS) & ADC_MASK); }

uint16_t HGCSample::gain ( ) const

inline

Definition at line 36 of file HGCSample.h.

References GAIN_MASK, GAIN_POS, and value_.

{ return ((value_ >> GAIN_POS) & GAIN_MASK); }

uint16_t HGCSample::operator() ( )

inline

Definition at line 38 of file HGCSample.h.

References value_.

{ return value_; }

uint16_t HGCSample::raw ( ) const

inline

getters

Definition at line 35 of file HGCSample.h.

References value_.

{ return value_; }

void HGCSample::set ( uint16_t  gain, uint16_t  adc  )

inline

Definition at line 30 of file HGCSample.h.

References setADC(), and setGain().

Referenced by betterConfigParser.BetterConfigParser::getGeneral().

{ setGain(gain);                     setADC(adc); }  

void HGCSample::setADC ( uint16_t  adc )

inline

Definition at line 29 of file HGCSample.h.

References ADC_MASK, ADC_POS, and setWord().

Referenced by set().

{ setWord(adc,ADC_MASK,ADC_POS);                  }

void HGCSample::setGain ( uint16_t  gain )

inline

setters

Definition at line 28 of file HGCSample.h.

References GAIN_MASK, GAIN_POS, and setWord().

Referenced by set().

{ setWord(gain,GAIN_MASK,GAIN_POS);               }

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

inlineprivate

wrapper to reset words at a given position

Definition at line 45 of file HGCSample.h.

References value_.

Referenced by setADC(), and setGain().

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

Member Data Documentation

uint16_t HGCSample::value_

private

Definition at line 54 of file HGCSample.h.

Referenced by adc(), gain(), operator()(), raw(), and setWord().