ChanFitErrorCode Class Reference

ChanFitErrorCode stores information about the calibration fit quality. More...

#include <ChanFitErrorCode.h>

Inheritance diagram for ChanFitErrorCode:

Collaboration diagram for ChanFitErrorCode:

Public Types
enum	ChanFitErrorCodeBits { NoDataBit = 0 , BadDataBit = 1 }

Public Member Functions
	ChanFitErrorCode ()
	ChanFitErrorCode (unsigned int errorCode)
	ChanFitErrorCode (const ChanFitErrorCode &e)
ChanFitErrorCode &	operator= (const ChanFitErrorCode &rhs)
ChanFitErrorCode &	operator|= (const ChanFitErrorCode &rhs)
bool	chanValid () const
bool	noData () const
void	noData (bool bad)
bool	badData () const
void	badData (bool bad)
unsigned int	errorCode () const
void	errorCode (unsigned int code)

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

Private Attributes
unsigned int	m_errorCode

Detailed Description

ChanFitErrorCode stores information about the calibration fit quality.

Author

Veit Scharf veit..nosp@m.scha.nosp@m.rf@ki.nosp@m.p.un.nosp@m.i-hei.nosp@m.delb.nosp@m.erg.d.nosp@m.e

Definition at line 16 of file ChanFitErrorCode.h.

Member Enumeration Documentation

ChanFitErrorCodeBits

enum ChanFitErrorCode::ChanFitErrorCodeBits

Enumerator
NoDataBit
BadDataBit

Definition at line 19 of file ChanFitErrorCode.h.

    {
      // to be extended
      NoDataBit = 0,
      BadDataBit = 1
    };

Constructor & Destructor Documentation

ChanFitErrorCode() [1/3]

ChanFitErrorCode::ChanFitErrorCode

(

)

Definition at line 7 of file ChanFitErrorCode.cxx.

                                   :
  AbstractErrorCode(0)
{}

ChanFitErrorCode() [2/3]

ChanFitErrorCode::ChanFitErrorCode

(

unsigned int

errorCode

)

Definition at line 11 of file ChanFitErrorCode.cxx.

                                                         :
  AbstractErrorCode(errorCode)
{}

ChanFitErrorCode() [3/3]

ChanFitErrorCode::ChanFitErrorCode

(

const ChanFitErrorCode &

e

)

Definition at line 15 of file ChanFitErrorCode.cxx.

                                                           :
  AbstractErrorCode(e.errorCode())
{}

Member Function Documentation

badData() [1/2]

bool ChanFitErrorCode::badData ( ) const

inline

Definition at line 40 of file ChanFitErrorCode.h.

{ return bitIsSet(BadDataBit); }

badData() [2/2]

void ChanFitErrorCode::badData ( bool bad )

inline

Definition at line 41 of file ChanFitErrorCode.h.

{ setBit(BadDataBit, 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;
}

chanValid()

bool ChanFitErrorCode::chanValid

(

)

const

Definition at line 30 of file ChanFitErrorCode.cxx.

                                       {
    return (this->errorCode() == 0);
}

errorCode() [1/2]

unsigned int AbstractErrorCode::errorCode ( ) const

inline

Definition at line 21 of file AbstractErrorCode.h.

{return m_errorCode;}

errorCode() [2/2]

void AbstractErrorCode::errorCode ( unsigned int code )

inline

Definition at line 26 of file AbstractErrorCode.h.

{m_errorCode = code;}

noData() [1/2]

bool ChanFitErrorCode::noData ( ) const

inline

Definition at line 37 of file ChanFitErrorCode.h.

{ return bitIsSet(NoDataBit); }

noData() [2/2]

void ChanFitErrorCode::noData ( bool bad )

inline

Definition at line 38 of file ChanFitErrorCode.h.

{ setBit(NoDataBit, bad); }

operator=()

ChanFitErrorCode & ChanFitErrorCode::operator=

(

const ChanFitErrorCode &

rhs

)

Definition at line 19 of file ChanFitErrorCode.cxx.

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

operator|=()

ChanFitErrorCode & ChanFitErrorCode::operator|=

(

const ChanFitErrorCode &

rhs

)

Definition at line 24 of file ChanFitErrorCode.cxx.

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

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

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:

• ChanFitErrorCode.h
• ChanFitErrorCode.cxx