FineTimeErrorCode Class Reference

FineTimeErrorCode class for L1Calo error codes. More...

#include <FineTimeErrorCode.h>

Inheritance diagram for FineTimeErrorCode:

Collaboration diagram for FineTimeErrorCode:

Public Types
enum	FineTimeBits { BadRefBit = 0 , BadCalibBit = 1 , RefSetByHand = 2 , CalibSetByHand = 3 }

Public Member Functions
	FineTimeErrorCode ()
	FineTimeErrorCode (unsigned int errorCode)
virtual	~FineTimeErrorCode ()
	FineTimeErrorCode (const FineTimeErrorCode &e)
FineTimeErrorCode &	operator= (const FineTimeErrorCode &e)
FineTimeErrorCode &	operator|= (const FineTimeErrorCode &e)
bool	badRefValue () const
void	badRefValue (bool bad)
bool	badCalib () const
void	badAdc (bool bad)
bool	isRefSetByHand () const
void	refIsSetByHand (bool bad)
bool	isCalibSetByHand () const
void	calibIsSetByHand (bool bad)
std::string	printStatus () const
unsigned int	errorCode () const

Protected Member Functions
void	errorCode (unsigned int code)
bool	bitIsSet (unsigned int number) const
void	setBit (unsigned int number, bool value)

Private Attributes
unsigned int	m_errorCode

Friends
std::ostream &	operator<< (std::ostream &output, const FineTimeErrorCode &r)

Detailed Description

FineTimeErrorCode class for L1Calo error codes.

Author

Damien Prieur damie.nosp@m.n.pr.nosp@m.ieur@.nosp@m.cern.nosp@m..ch

Definition at line 19 of file FineTimeErrorCode.h.

Member Enumeration Documentation

FineTimeBits

enum FineTimeErrorCode::FineTimeBits

Enumerator
BadRefBit
BadCalibBit
RefSetByHand
CalibSetByHand

Definition at line 25 of file FineTimeErrorCode.h.

                      {
      
        BadRefBit = 0,     //set if reference value couldn't be retrieved
        BadCalibBit = 1,     //set if calib value couldn't be retrieved
        RefSetByHand = 2,   //set if the reference value is set by hand
        CalibSetByHand = 3    //set if the calibration value is set by hand
    };

Constructor & Destructor Documentation

FineTimeErrorCode() [1/3]

FineTimeErrorCode::FineTimeErrorCode

(

)

Definition at line 12 of file FineTimeErrorCode.cxx.

                                     : AbstractErrorCode(0) {
}

FineTimeErrorCode() [2/3]

FineTimeErrorCode::FineTimeErrorCode

(

unsigned int

errorCode

)

Definition at line 15 of file FineTimeErrorCode.cxx.

                                                          : AbstractErrorCode(errorCode) {
}

~FineTimeErrorCode()

virtual FineTimeErrorCode::~FineTimeErrorCode ( )

inlinevirtual

Definition at line 35 of file FineTimeErrorCode.h.

{}

FineTimeErrorCode() [3/3]

FineTimeErrorCode::FineTimeErrorCode

(

const FineTimeErrorCode &

e

)

Definition at line 18 of file FineTimeErrorCode.cxx.

                                                               : AbstractErrorCode (e.errorCode()) {
}

Member Function Documentation

badAdc()

void FineTimeErrorCode::badAdc ( bool bad )

inline

Definition at line 45 of file FineTimeErrorCode.h.

{ setBit(BadCalibBit,bad); }

badCalib()

bool FineTimeErrorCode::badCalib ( ) const

inline

Definition at line 44 of file FineTimeErrorCode.h.

{ return bitIsSet(BadCalibBit); }

badRefValue() [1/2]

bool FineTimeErrorCode::badRefValue ( ) const

inline

Definition at line 41 of file FineTimeErrorCode.h.

{ return bitIsSet(BadRefBit); }

badRefValue() [2/2]

void FineTimeErrorCode::badRefValue ( bool bad )

inline

Definition at line 42 of file FineTimeErrorCode.h.

{ setBit(BadRefBit,bad); }

bitIsSet()

bool AbstractErrorCode::bitIsSet ( unsigned int number ) const

protectedinherited

Definition at line 7 of file AbstractErrorCode.cxx.

                                                          {
  unsigned int correspondingNumber = (unsigned int) (1<<number);
 
  bool isSet( ( m_errorCode & correspondingNumber) > 0);
 
  return isSet;
}

calibIsSetByHand()

void FineTimeErrorCode::calibIsSetByHand ( bool bad )

inline

Definition at line 51 of file FineTimeErrorCode.h.

{ setBit(CalibSetByHand,bad); }

errorCode() [1/2]

unsigned int AbstractErrorCode::errorCode ( ) const

inlineinherited

Definition at line 21 of file AbstractErrorCode.h.

{return m_errorCode;}

errorCode() [2/2]

void AbstractErrorCode::errorCode ( unsigned int code )

inlineprotectedinherited

Definition at line 26 of file AbstractErrorCode.h.

{m_errorCode = code;}

isCalibSetByHand()

bool FineTimeErrorCode::isCalibSetByHand ( ) const

inline

Definition at line 50 of file FineTimeErrorCode.h.

{ return bitIsSet(CalibSetByHand); }

isRefSetByHand()

bool FineTimeErrorCode::isRefSetByHand ( ) const

inline

Definition at line 47 of file FineTimeErrorCode.h.

{ return bitIsSet(RefSetByHand); }

operator=()

FineTimeErrorCode & FineTimeErrorCode::operator=

(

const FineTimeErrorCode &

e

)

Definition at line 21 of file FineTimeErrorCode.cxx.

{
    this->errorCode(e.errorCode());
    return *this;
}

operator|=()

FineTimeErrorCode & FineTimeErrorCode::operator|=

(

const FineTimeErrorCode &

e

)

Definition at line 27 of file FineTimeErrorCode.cxx.

{
    this->errorCode( this->errorCode() | e.errorCode() );
    return *this;
}

printStatus()

std::string FineTimeErrorCode::printStatus

(

)

const

Definition at line 33 of file FineTimeErrorCode.cxx.

                                               {
 
    std::stringstream status;
 
    status << "ErrorCode: " << this->errorCode() << std::endl;
 
    status << "Bit " << std::setw(2) << BadRefBit
         << ": BadRefBit:                   "
         << bitIsSet(BadRefBit) << std::endl;
 
    status << "Bit " << std::setw(2) << BadCalibBit
         << ": BadCalibBit:                   "
         << bitIsSet(BadCalibBit) << std::endl;
 
    status << "Bit " << std::setw(2) << RefSetByHand
         << ": RefSetByHand:                   "
         << bitIsSet(RefSetByHand) << std::endl;
    status << "Bit " << std::setw(2) << CalibSetByHand
         << ": CalibSetByHand:                   "
         << bitIsSet(CalibSetByHand) << std::endl;
 
    return status.str();
}

refIsSetByHand()

void FineTimeErrorCode::refIsSetByHand ( bool bad )

inline

Definition at line 48 of file FineTimeErrorCode.h.

{ setBit(RefSetByHand,bad); }

setBit()

void AbstractErrorCode::setBit ( unsigned int number, bool value )

protectedinherited

Definition at line 15 of file AbstractErrorCode.cxx.

                                                              {
  bool isSet(bitIsSet(number));
  unsigned int correspondingNumber = (unsigned int) (1<<number);
 
  // set bit if not set yet
  if ((value) && (!isSet)) m_errorCode |= correspondingNumber;
  // remove bit if bit is set
  if ((!value) && (isSet)) m_errorCode &= ~correspondingNumber;
}

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & output, const FineTimeErrorCode & r )

friend

Definition at line 58 of file FineTimeErrorCode.cxx.

                                                                        {
    output << r.errorCode();
    return output;
}

Member Data Documentation

m_errorCode

unsigned int AbstractErrorCode::m_errorCode

privateinherited

Definition at line 32 of file AbstractErrorCode.h.

---

The documentation for this class was generated from the following files:

• FineTimeErrorCode.h
• FineTimeErrorCode.cxx