LArBadFeb Class Reference

#include <LArBadFeb.h>

Inheritance diagram for LArBadFeb:

Collaboration diagram for LArBadFeb:

Public Types
enum	ProblemType {   deadAllBit = 0 , deadReadoutBit = 1 , inErrorBit = 2 , deactivatedInOKSBit = 3 ,   maskParity = 16 , maskBCID =17 , maskSampleHeader = 18 , maskEVTID = 19 ,   maskScacStatus = 20 , maskScaOutOfRange = 21 , maskGainMismatch = 22 , maskTypeMismatch = 23 ,   maskNumOfSamples = 24 , maskEmptyDataBlock = 25 , maskDspBlockSize = 26 , maskCheckSum = 27 ,   maskMissingHeader = 28 , maskBadGain = 29 }
typedef unsigned int	PosType
typedef unsigned int	BitWord

Public Member Functions
	LArBadFeb ()
	LArBadFeb (BitWord rawStatus)
bool	statusBad (ProblemType pb) const
	Returns true if corresponding status bit its set.
bool	statusOK (ProblemType pb) const
	Returns true if there is no problem in corresponding status bit.
bool	good () const
	Returns true if no problems at all (all bits at zero)
bool	deadAll () const
	FEB is completely missing, e.g. powered off.
bool	deadReadout () const
	FEB is not sending readout data, but the L1 trigger path is working.
bool	inError () const
	FEB has readout errors, cannot be used.
bool	deactivatedInOKS () const
	Deactivated in OKS.
unsigned int	ignoreErrors () const
bool	operator!= (BitWord other)
bool	operator!= (LArBadFeb other)
bool	operator== (BitWord other)
bool	operator== (LArBadFeb other)
LArBadFeb &	operator|= (LArBadFeb other)
BitWord	packedData () const

Static Public Member Functions
static PosType	bitPosition (ProblemType pb)

Private Member Functions
BitWord &	packedDataRef ()

Private Attributes
BitWord	m_word

Friends
class	LArBadFebBitPacking

Detailed Description

Definition at line 10 of file LArBadFeb.h.

Member Typedef Documentation

BitWord

typedef unsigned int LArBadFebEnum::BitWord

inherited

Definition at line 13 of file LArBadFebEnum.h.

PosType

typedef unsigned int LArBadFebEnum::PosType

inherited

Definition at line 12 of file LArBadFebEnum.h.

Member Enumeration Documentation

ProblemType

enum LArBadFebEnum::ProblemType

inherited

Enumerator
deadAllBit
deadReadoutBit
inErrorBit
deactivatedInOKSBit
maskParity
maskBCID
maskSampleHeader
maskEVTID
maskScacStatus
maskScaOutOfRange
maskGainMismatch
maskTypeMismatch
maskNumOfSamples
maskEmptyDataBlock
maskDspBlockSize
maskCheckSum
maskMissingHeader
maskBadGain

Definition at line 15 of file LArBadFebEnum.h.

                   {
    deadAllBit = 0, 
    deadReadoutBit = 1, 
    inErrorBit = 2, 
    deactivatedInOKSBit = 3,   //From LArFebErrorSummary.h:
    maskParity         = 16,   //Parity,       
    maskBCID            =17,   //BCID,       
    maskSampleHeader   = 18,   //SampleHeader,   
    maskEVTID          = 19,   //EVTID,         
    maskScacStatus     = 20,   //ScacStatus,   
    maskScaOutOfRange  = 21,   //ScaOutOfRange,     
    maskGainMismatch   = 22,   //GainMismatch,   
    maskTypeMismatch   = 23,   //TypeMismatch,   
    maskNumOfSamples   = 24,   //NumOfSamples,   
    maskEmptyDataBlock = 25,   //EmptyDataBlock,   
    maskDspBlockSize   = 26,   //DspBlockSize,   
    maskCheckSum       = 27,   //CheckSum,   
    maskMissingHeader  = 28,    //MissingHeader,    
    maskBadGain        = 29    //BadGain,     
                               //N_LArFebErrorType
  };                   

Constructor & Destructor Documentation

LArBadFeb() [1/2]

LArBadFeb::LArBadFeb ( )

inline

Definition at line 13 of file LArBadFeb.h.

: m_word(0) {}

LArBadFeb() [2/2]

LArBadFeb::LArBadFeb ( BitWord rawStatus )

inlineexplicit

Definition at line 15 of file LArBadFeb.h.

: m_word(rawStatus) {}

Member Function Documentation

bitPosition()

PosType LArBadFeb::bitPosition ( ProblemType pb )

inlinestatic

Definition at line 43 of file LArBadFeb.h.

{ return static_cast<PosType>(pb);}

deactivatedInOKS()

bool LArBadFeb::deactivatedInOKS ( ) const

inline

Deactivated in OKS.

Definition at line 39 of file LArBadFeb.h.

{return statusBad( deactivatedInOKSBit);}

deadAll()

bool LArBadFeb::deadAll ( ) const

inline

FEB is completely missing, e.g. powered off.

Definition at line 30 of file LArBadFeb.h.

{return statusBad( deadAllBit);} 

deadReadout()

bool LArBadFeb::deadReadout ( ) const

inline

FEB is not sending readout data, but the L1 trigger path is working.

Definition at line 33 of file LArBadFeb.h.

{return statusBad( deadReadoutBit);}

good()

bool LArBadFeb::good ( ) const

inline

Returns true if no problems at all (all bits at zero)

Definition at line 27 of file LArBadFeb.h.

{return (m_word << 16) == 0;} // only use the lower 16 bits

ignoreErrors()

unsigned int LArBadFeb::ignoreErrors ( ) const

inline

Definition at line 65 of file LArBadFeb.h.

{
  return (m_word >> 16);  // return the most significant 16 bits 
}

inError()

bool LArBadFeb::inError ( ) const

inline

FEB has readout errors, cannot be used.

Definition at line 36 of file LArBadFeb.h.

{return statusBad( inErrorBit);}

operator!=() [1/2]

bool LArBadFeb::operator!= ( BitWord other )

inline

Definition at line 45 of file LArBadFeb.h.

{return m_word != other;}

operator!=() [2/2]

bool LArBadFeb::operator!= ( LArBadFeb other )

inline

Definition at line 46 of file LArBadFeb.h.

{return m_word != other.packedData();}

operator==() [1/2]

bool LArBadFeb::operator== ( BitWord other )

inline

Definition at line 47 of file LArBadFeb.h.

{return m_word == other;}

operator==() [2/2]

bool LArBadFeb::operator== ( LArBadFeb other )

inline

Definition at line 48 of file LArBadFeb.h.

{return m_word == other.packedData();}

operator|=()

LArBadFeb & LArBadFeb::operator|= ( LArBadFeb other )

inline

Definition at line 50 of file LArBadFeb.h.

{m_word|=other.m_word; return *this;}

packedData()

BitWord LArBadFeb::packedData ( ) const

inline

Definition at line 52 of file LArBadFeb.h.

{return m_word;}

packedDataRef()

BitWord & LArBadFeb::packedDataRef ( )

inlineprivate

Definition at line 58 of file LArBadFeb.h.

{return m_word;}

statusBad()

bool LArBadFeb::statusBad ( ProblemType pb ) const

inline

Returns true if corresponding status bit its set.

Definition at line 18 of file LArBadFeb.h.

                                        {
    BitWord mask = 1 << bitPosition(pb);
    return ((m_word & mask) != 0);
  }

statusOK()

bool LArBadFeb::statusOK ( ProblemType pb ) const

inline

Returns true if there is no problem in corresponding status bit.

Definition at line 24 of file LArBadFeb.h.

{return !statusBad(pb);}

Friends And Related Symbol Documentation

LArBadFebBitPacking

friend class LArBadFebBitPacking

friend

Definition at line 60 of file LArBadFeb.h.

Member Data Documentation

m_word

BitWord LArBadFeb::m_word

private

Definition at line 56 of file LArBadFeb.h.

---

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

• LArBadFeb.h