CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends
HcalChannelStatus Class Reference

#include <HcalChannelStatus.h>

Public Types

enum  StatusBit {
  HcalCellOff = 0, HcalCellMask = 1, HcalCellDead = 5, HcalCellHot = 6,
  HcalCellStabErr = 7, HcalCellTimErr = 8, HcalCellExcludeFromHBHENoiseSummary = 9, HcalCellExcludeFromHBHENoiseSummaryR45,
  HcalBadLaserSignal = 11, HcalCellTrigMask = 15, HcalCellCaloTowerMask = 18, HcalCellCaloTowerProb = 19
}
 

Public Member Functions

uint32_t getValue () const
 
 HcalChannelStatus ()
 
 HcalChannelStatus (unsigned long fid, uint32_t status)
 
bool isBitSet (unsigned int bitnumber) const
 
uint32_t rawId () const
 
void setBit (unsigned int bitnumber)
 
void setValue (uint32_t value)
 
void unsetBit (unsigned int bitnumber)
 

Private Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Private Attributes

uint32_t mId
 
uint32_t mStatus
 

Friends

class boost::serialization::access
 
template<typename CondSerializationT , typename Enabled >
struct cond::serialization::access
 

Detailed Description

Definition at line 13 of file HcalChannelStatus.h.

Member Enumeration Documentation

◆ StatusBit

Enumerator
HcalCellOff 
HcalCellMask 
HcalCellDead 
HcalCellHot 
HcalCellStabErr 
HcalCellTimErr 
HcalCellExcludeFromHBHENoiseSummary 
HcalCellExcludeFromHBHENoiseSummaryR45 
HcalBadLaserSignal 
HcalCellTrigMask 
HcalCellCaloTowerMask 
HcalCellCaloTowerProb 

Definition at line 16 of file HcalChannelStatus.h.

16  {
17  HcalCellOff = 0, // 1=Hcal cell is off
18  HcalCellMask = 1, // 1=Hcal cell is masked/to be masked at RecHit Level
19  // Quality Bits
20  HcalCellDead = 5, // 1=Hcal cell is dead (from DQM algo)
21  HcalCellHot = 6, // 1=Hcal cell is hot (from DQM algo)
22  HcalCellStabErr = 7, // 1=Hcal cell has stability error
23  HcalCellTimErr = 8, // 1=Hcal cell has timing error
24  HcalCellExcludeFromHBHENoiseSummary = 9, //1=cell is completely excluded from all HBHENoiseSummary computations
26  10, //1=cell's rechit is excluded when calculating the TS4TS5 ratio only in the HBHE Noise Summary
27  HcalBadLaserSignal = 11, //1 = channel does not receive good laser calibration signal
28  // Trigger Bits
29  HcalCellTrigMask = 15, // 1=cell is masked from the Trigger
30  // CaloTower Bits
31  HcalCellCaloTowerMask = 18, // 1=cell is always excluded from the CaloTower, regardless of other bit settings.
32  HcalCellCaloTowerProb = 19 // 1=cell is counted as problematic within the tower.
33  };

Constructor & Destructor Documentation

◆ HcalChannelStatus() [1/2]

HcalChannelStatus::HcalChannelStatus ( )
inline

Definition at line 35 of file HcalChannelStatus.h.

35 : mId(0), mStatus(0) {}

◆ HcalChannelStatus() [2/2]

HcalChannelStatus::HcalChannelStatus ( unsigned long  fid,
uint32_t  status 
)
inline

Definition at line 36 of file HcalChannelStatus.h.

Member Function Documentation

◆ getValue()

uint32_t HcalChannelStatus::getValue ( ) const
inline

◆ isBitSet()

bool HcalChannelStatus::isBitSet ( unsigned int  bitnumber) const
inline

Definition at line 53 of file HcalChannelStatus.h.

References mStatus.

Referenced by reco::HcalNoiseInfoProducer::filldigis(), and reco::HcalNoiseInfoProducer::fillrechits().

53  {
54  uint32_t statadd = 0x1 << (bitnumber);
55  return (mStatus & statadd) ? (true) : (false);
56  }

◆ rawId()

uint32_t HcalChannelStatus::rawId ( ) const
inline

Definition at line 58 of file HcalChannelStatus.h.

References mId.

58 { return mId; }

◆ serialize()

template<class Archive >
void HcalChannelStatus::serialize ( Archive &  ar,
const unsigned int  version 
)
private

◆ setBit()

void HcalChannelStatus::setBit ( unsigned int  bitnumber)
inline

Definition at line 43 of file HcalChannelStatus.h.

References mStatus.

43  {
44  uint32_t statadd = 0x1 << (bitnumber);
45  mStatus = mStatus | statadd;
46  }

◆ setValue()

void HcalChannelStatus::setValue ( uint32_t  value)
inline

◆ unsetBit()

void HcalChannelStatus::unsetBit ( unsigned int  bitnumber)
inline

Definition at line 47 of file HcalChannelStatus.h.

References mStatus.

47  {
48  uint32_t statadd = 0x1 << (bitnumber);
49  statadd = ~statadd;
50  mStatus = mStatus & statadd;
51  }

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 66 of file HcalChannelStatus.h.

◆ cond::serialization::access

template<typename CondSerializationT , typename Enabled >
friend struct cond::serialization::access
friend

Definition at line 66 of file HcalChannelStatus.h.

Member Data Documentation

◆ mId

uint32_t HcalChannelStatus::mId
private

Definition at line 63 of file HcalChannelStatus.h.

Referenced by rawId().

◆ mStatus

uint32_t HcalChannelStatus::mStatus
private

Definition at line 64 of file HcalChannelStatus.h.

Referenced by getValue(), isBitSet(), setBit(), setValue(), and unsetBit().