ATLAS Offline Software
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | Friends | List of all members
ChanDeadErrorCode Class Reference

ChanDeadErrorCode class for L1Calo error codes Adapted from /LVL1/l1calo/coolL1Calo/coolL1Calo/ChanDeadCode.h. More...

#include <ChanDeadErrorCode.h>

Inheritance diagram for ChanDeadErrorCode:
Collaboration diagram for ChanDeadErrorCode:

Public Types

enum  ChanDeadBits {
  BadLvdsBit = 0 , BadAdcBit = 0 , BadMcmBit = 1 , FrontEndDeadBit = 4 ,
  ReceiverDeadBit = 5 , HighVoltsOffBit = 6 , LowVoltsOffBit = 7 , NoisyTowerBit = 8 ,
  PSCellsMaskedBit = 16 , FrontCellsMaskedBit = 17 , MiddleCellsMaskedBit = 18 , BackCellsMaskedBit = 19
}

Public Member Functions

 ChanDeadErrorCode ()
 ChanDeadErrorCode (unsigned int errorCode)
virtual ~ChanDeadErrorCode ()
 ChanDeadErrorCode (const ChanDeadErrorCode &e)
ChanDeadErrorCode & operator= (const ChanDeadErrorCode &e)
ChanDeadErrorCode & operator= (ChanDeadErrorCode &&) noexcept=default
ChanDeadErrorCode & operator|= (const ChanDeadErrorCode &e)
bool chanValid () const
bool badLvds () const
void badLvds (bool bad)
bool badAdc () const
void badAdc (bool bad)
bool badMcm () const
void badMcm (bool bad)
bool frontEndDead () const
void frontEndDead (bool bad)
bool receiverDead () const
void receiverDead (bool bad)
bool highVoltsOff () const
void highVoltsOff (bool bad)
bool lowVoltsOff () const
void lowVoltsOff (bool bad)
bool noisyTower () const
void noisyTower (bool bad)
bool psCellsMasked () const
void psCellsMasked (bool bad)
bool frontCellsMasked () const
void frontCellsMasked (bool bad)
bool middleCellsMasked () const
void middleCellsMasked (bool bad)
bool backCellsMasked () const
void backCellsMasked (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 ChanDeadErrorCode &r)

Detailed Description

ChanDeadErrorCode class for L1Calo error codes Adapted from /LVL1/l1calo/coolL1Calo/coolL1Calo/ChanDeadCode.h.

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

Definition at line 21 of file ChanDeadErrorCode.h.

Member Enumeration Documentation

◆ ChanDeadBits

enum ChanDeadErrorCode::ChanDeadBits
Enumerator
BadLvdsBit 
BadAdcBit 
BadMcmBit 
FrontEndDeadBit 
ReceiverDeadBit 
HighVoltsOffBit 
LowVoltsOffBit 
NoisyTowerBit 
PSCellsMaskedBit 
FrontCellsMaskedBit 
MiddleCellsMaskedBit 
BackCellsMaskedBit 

Definition at line 27 of file ChanDeadErrorCode.h.

27 {
28 // Bits used for CPM/JEM dead channel folders.
29 BadLvdsBit = 0,
30
31 // Bits used for PPM dead (or problem) channel folder.
32 // Bits 0-15 will zero the LUT if they are set.
33 // Bits 16-31 are flagging problems that do not need
34 // the LUT to be zeroed.
35
36 // Internal L1Calo problems:
37 BadAdcBit = 0,
38 BadMcmBit = 1,
39
40 // Calorimeter problems:
41 FrontEndDeadBit = 4,
42 ReceiverDeadBit = 5,
43 HighVoltsOffBit = 6,
44 LowVoltsOffBit = 7,
45 NoisyTowerBit = 8,
46
47 // Calorimeter flags:
48 // (for Tile, can use A=Front, B/C=Middle, D=Back)
49 PSCellsMaskedBit = 16,
50 FrontCellsMaskedBit = 17,
51 MiddleCellsMaskedBit = 18,
52 BackCellsMaskedBit = 19
53 };

Constructor & Destructor Documentation

◆ ChanDeadErrorCode() [1/3]

ChanDeadErrorCode::ChanDeadErrorCode ( )

Definition at line 12 of file ChanDeadErrorCode.cxx.

12 : AbstractErrorCode(0) {
13}
AbstractErrorCode::AbstractErrorCode
AbstractErrorCode(unsigned int errorCode)
Definition AbstractErrorCode.h:24

◆ ChanDeadErrorCode() [2/3]

ChanDeadErrorCode::ChanDeadErrorCode ( unsigned int errorCode)

Definition at line 15 of file ChanDeadErrorCode.cxx.

15 : AbstractErrorCode(errorCode) {
16}
AbstractErrorCode::errorCode
unsigned int errorCode() const
Definition AbstractErrorCode.h:21

◆ ~ChanDeadErrorCode()

virtual ChanDeadErrorCode::~ChanDeadErrorCode ( )
inlinevirtual

Definition at line 57 of file ChanDeadErrorCode.h.

57{}

◆ ChanDeadErrorCode() [3/3]

ChanDeadErrorCode::ChanDeadErrorCode ( const ChanDeadErrorCode & e)

Definition at line 18 of file ChanDeadErrorCode.cxx.

18 : AbstractErrorCode (e.errorCode()) {
19}

Member Function Documentation

◆ backCellsMasked() [1/2]

bool ChanDeadErrorCode::backCellsMasked ( ) const
inline

Definition at line 99 of file ChanDeadErrorCode.h.

99{ return bitIsSet(BackCellsMaskedBit); }
AbstractErrorCode::bitIsSet
bool bitIsSet(unsigned int number) const
Definition AbstractErrorCode.cxx:7

◆ backCellsMasked() [2/2]

void ChanDeadErrorCode::backCellsMasked ( bool bad)
inline

Definition at line 100 of file ChanDeadErrorCode.h.

100{ setBit(BackCellsMaskedBit,bad); }
AbstractErrorCode::setBit
void setBit(unsigned int number, bool value)
Definition AbstractErrorCode.cxx:15

◆ badAdc() [1/2]

bool ChanDeadErrorCode::badAdc ( ) const
inline

Definition at line 69 of file ChanDeadErrorCode.h.

69{ return bitIsSet(BadAdcBit); }

◆ badAdc() [2/2]

void ChanDeadErrorCode::badAdc ( bool bad)
inline

Definition at line 70 of file ChanDeadErrorCode.h.

70{ setBit(BadAdcBit,bad); }

◆ badLvds() [1/2]

bool ChanDeadErrorCode::badLvds ( ) const
inline

Definition at line 66 of file ChanDeadErrorCode.h.

66{ return bitIsSet(BadLvdsBit); }

◆ badLvds() [2/2]

void ChanDeadErrorCode::badLvds ( bool bad)
inline

Definition at line 67 of file ChanDeadErrorCode.h.

67{ setBit(BadLvdsBit,bad); }

◆ badMcm() [1/2]

bool ChanDeadErrorCode::badMcm ( ) const
inline

Definition at line 72 of file ChanDeadErrorCode.h.

72{ return bitIsSet(BadMcmBit); }

◆ badMcm() [2/2]

void ChanDeadErrorCode::badMcm ( bool bad)
inline

Definition at line 73 of file ChanDeadErrorCode.h.

73{ setBit(BadMcmBit,bad); }

◆ bitIsSet()

bool AbstractErrorCode::bitIsSet ( unsigned int number) const
protectedinherited

Definition at line 7 of file AbstractErrorCode.cxx.

7 {
8 unsigned int correspondingNumber = (unsigned int) (1<<number);
9
10 bool isSet( ( m_errorCode & correspondingNumber) > 0);
11
12 return isSet;
13}
AbstractErrorCode::m_errorCode
unsigned int m_errorCode
Definition AbstractErrorCode.h:33
number
std::string number(const double &d, const std::string &s)
Definition utils.cxx:186

◆ chanValid()

bool ChanDeadErrorCode::chanValid ( ) const
inline

Definition at line 64 of file ChanDeadErrorCode.h.

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

◆ errorCode() [1/2]

unsigned int AbstractErrorCode::errorCode ( ) const
inlineinherited

Definition at line 21 of file AbstractErrorCode.h.

21{return m_errorCode;}

◆ errorCode() [2/2]

void AbstractErrorCode::errorCode ( unsigned int code)
inlineprotectedinherited

Definition at line 26 of file AbstractErrorCode.h.

26{m_errorCode = code;}

◆ frontCellsMasked() [1/2]

bool ChanDeadErrorCode::frontCellsMasked ( ) const
inline

Definition at line 93 of file ChanDeadErrorCode.h.

93{ return bitIsSet(FrontCellsMaskedBit); }

◆ frontCellsMasked() [2/2]

void ChanDeadErrorCode::frontCellsMasked ( bool bad)
inline

Definition at line 94 of file ChanDeadErrorCode.h.

94{ setBit(FrontCellsMaskedBit,bad); }

◆ frontEndDead() [1/2]

bool ChanDeadErrorCode::frontEndDead ( ) const
inline

Definition at line 75 of file ChanDeadErrorCode.h.

75{ return bitIsSet(FrontEndDeadBit); }

◆ frontEndDead() [2/2]

void ChanDeadErrorCode::frontEndDead ( bool bad)
inline

Definition at line 76 of file ChanDeadErrorCode.h.

76{ setBit(FrontEndDeadBit,bad); }

◆ highVoltsOff() [1/2]

bool ChanDeadErrorCode::highVoltsOff ( ) const
inline

Definition at line 81 of file ChanDeadErrorCode.h.

81{ return bitIsSet(HighVoltsOffBit); }

◆ highVoltsOff() [2/2]

void ChanDeadErrorCode::highVoltsOff ( bool bad)
inline

Definition at line 82 of file ChanDeadErrorCode.h.

82{ setBit(HighVoltsOffBit,bad); }

◆ lowVoltsOff() [1/2]

bool ChanDeadErrorCode::lowVoltsOff ( ) const
inline

Definition at line 84 of file ChanDeadErrorCode.h.

84{ return bitIsSet(LowVoltsOffBit); }

◆ lowVoltsOff() [2/2]

void ChanDeadErrorCode::lowVoltsOff ( bool bad)
inline

Definition at line 85 of file ChanDeadErrorCode.h.

85{ setBit(LowVoltsOffBit,bad); }

◆ middleCellsMasked() [1/2]

bool ChanDeadErrorCode::middleCellsMasked ( ) const
inline

Definition at line 96 of file ChanDeadErrorCode.h.

96{ return bitIsSet(MiddleCellsMaskedBit); }

◆ middleCellsMasked() [2/2]

void ChanDeadErrorCode::middleCellsMasked ( bool bad)
inline

Definition at line 97 of file ChanDeadErrorCode.h.

97{ setBit(MiddleCellsMaskedBit,bad); }

◆ noisyTower() [1/2]

bool ChanDeadErrorCode::noisyTower ( ) const
inline

Definition at line 87 of file ChanDeadErrorCode.h.

87{ return bitIsSet(NoisyTowerBit); }

◆ noisyTower() [2/2]

void ChanDeadErrorCode::noisyTower ( bool bad)
inline

Definition at line 88 of file ChanDeadErrorCode.h.

88{ setBit(NoisyTowerBit,bad); }

◆ operator=() [1/2]

ChanDeadErrorCode & ChanDeadErrorCode::operator= ( ChanDeadErrorCode && )
defaultnoexcept

◆ operator=() [2/2]

ChanDeadErrorCode & ChanDeadErrorCode::operator= ( const ChanDeadErrorCode & e)

Definition at line 21 of file ChanDeadErrorCode.cxx.

22{
23 this->errorCode(e.errorCode());
24 return *this;
25}

◆ operator|=()

ChanDeadErrorCode & ChanDeadErrorCode::operator|= ( const ChanDeadErrorCode & e)

Definition at line 27 of file ChanDeadErrorCode.cxx.

28{
29 this->errorCode( this->errorCode() | e.errorCode() );
30 return *this;
31}

◆ printStatus()

std::string ChanDeadErrorCode::printStatus ( ) const

Definition at line 33 of file ChanDeadErrorCode.cxx.

33 {
34
35 std::stringstream status;
36
37 status << "ErrorCode: " << this->errorCode() << std::endl;
38
39 status << "Bit " << std::setw(2) << BadAdcBit
40 << ": BadAdcBit: "
41 << bitIsSet(BadAdcBit) << std::endl;
42
43 status << "Bit " << std::setw(2) << BadMcmBit
44 << ": BadMcmBit: "
45 << bitIsSet(BadMcmBit) << std::endl;
46
47 status << "Bit " << std::setw(2) << FrontEndDeadBit
48 << ": FrontEndDeadBit: "
49 << bitIsSet(FrontEndDeadBit) << std::endl;
50
51 status << "Bit " << std::setw(2) << ReceiverDeadBit
52 << ": ReceiverDeadBit: "
53 << bitIsSet(ReceiverDeadBit) << std::endl;
54
55 status << "Bit " << std::setw(2) << HighVoltsOffBit
56 << ": HighVoltsOffBit: "
57 << bitIsSet(HighVoltsOffBit) << std::endl;
58
59 status << "Bit " << std::setw(2) << LowVoltsOffBit
60 << ": LowVoltsOffBit: "
61 << bitIsSet(LowVoltsOffBit) << std::endl;
62
63 status << "Bit " << std::setw(2) << NoisyTowerBit
64 << ": NoisyTowerBit: "
65 << bitIsSet(NoisyTowerBit) << std::endl;
66
67 status << "Bit " << std::setw(2) << PSCellsMaskedBit
68 << ": PSCellsMaskedBit: "
69 << bitIsSet(PSCellsMaskedBit) << std::endl;
70
71 status << "Bit " << std::setw(2) << FrontCellsMaskedBit
72 << ": FrontCellsMaskedBit: "
73 << bitIsSet(FrontCellsMaskedBit) << std::endl;
74
75 status << "Bit " << std::setw(2) << MiddleCellsMaskedBit
76 << ": MiddleCellsMaskedBit: "
77 << bitIsSet(MiddleCellsMaskedBit) << std::endl;
78
79 status << "Bit " << std::setw(2) << BackCellsMaskedBit
80 << ": BackCellsMaskedBit: "
81 << bitIsSet(BackCellsMaskedBit) << std::endl;
82
83 return status.str();
84}
merge.status
status
Definition merge.py:16

◆ psCellsMasked() [1/2]

bool ChanDeadErrorCode::psCellsMasked ( ) const
inline

Definition at line 90 of file ChanDeadErrorCode.h.

90{ return bitIsSet(PSCellsMaskedBit); }

◆ psCellsMasked() [2/2]

void ChanDeadErrorCode::psCellsMasked ( bool bad)
inline

Definition at line 91 of file ChanDeadErrorCode.h.

91{ setBit(PSCellsMaskedBit,bad); }

◆ receiverDead() [1/2]

bool ChanDeadErrorCode::receiverDead ( ) const
inline

Definition at line 78 of file ChanDeadErrorCode.h.

78{ return bitIsSet(ReceiverDeadBit); }

◆ receiverDead() [2/2]

void ChanDeadErrorCode::receiverDead ( bool bad)
inline

Definition at line 79 of file ChanDeadErrorCode.h.

79{ setBit(ReceiverDeadBit,bad); }

◆ setBit()

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

Definition at line 15 of file AbstractErrorCode.cxx.

15 {
16 bool isSet(bitIsSet(number));
17 unsigned int correspondingNumber = (unsigned int) (1<<number);
18
19 // set bit if not set yet
20 if ((value) && (!isSet)) m_errorCode |= correspondingNumber;
21 // remove bit if bit is set
22 if ((!value) && (isSet)) m_errorCode &= ~correspondingNumber;
23}

◆ operator<<

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

Definition at line 87 of file ChanDeadErrorCode.cxx.

87 {
88 output << r.errorCode();
89 return output;
90}
r
int r
Definition globals.cxx:22
merge.output
output
Definition merge.py:16

Member Data Documentation

◆ m_errorCode

unsigned int AbstractErrorCode::m_errorCode {}
privateinherited

Definition at line 33 of file AbstractErrorCode.h.

33{};
The documentation for this class was generated from the following files:
Generated on for ATLAS Offline Software by doxygen 1.17.0