EcalSrFlag Class Reference

#include <EcalSrFlag.h>

Inheritance diagram for EcalSrFlag:

Public Member Functions
std::string	flagName () const
virtual const DetId &	id () const =0
	operator int () const
void	setValue (const int &flag)
int	value () const
virtual	~EcalSrFlag ()

Static Public Member Functions
static std::string	flagName (const int &flag)

Static Public Attributes
static const int	SRF_FORCED_MASK = 0x4
static const int	SRF_FULL = 3
static const int	SRF_SUPPRESS = 0
static const int	SRF_ZS1 = 1
static const int	SRF_ZS2 = 2

Protected Attributes
unsigned char	flag_

Static Private Attributes
static const char *const	srfNames []

Detailed Description

Base class for Selective Readout Flag (SR flag or SRF).

Definition at line 10 of file EcalSrFlag.h.

Constructor & Destructor Documentation

~EcalSrFlag()

virtual EcalSrFlag::~EcalSrFlag ( )

inlinevirtual

Destructor

Definition at line 34 of file EcalSrFlag.h.

{};

Member Function Documentation

flagName() [1/2]

static std::string EcalSrFlag::flagName ( const int &  flag )

inlinestatic

Return a human readable flag name from its integer value.

Parameters

flag	the flag value

Returns

the human readable string (which can contain space).

Definition at line 60 of file EcalSrFlag.h.

References RemoveAddSevLevel::flag, and srfNames.

Referenced by operator<<().

{ return (flag == (flag & 0x7)) ? srfNames[flag] : "Invalid"; }

flagName() [2/2]

std::string EcalSrFlag::flagName ( ) const

inline

Return a human readable flag name from the flag value.

Returns

the human readable string (which can contain space).

Definition at line 65 of file EcalSrFlag.h.

References flag_, and flagName().

Referenced by flagName().

{ return flagName(flag_); }

id()

virtual const DetId& EcalSrFlag::id ( ) const

pure virtual

Gets the Det Id the flag is associated to.

Returns

the det id of the readout unit (a barrel TT or a SC).

Implemented in EESrFlag, and EBSrFlag.

Referenced by EcalDigiToRaw::produce().

operator int()

EcalSrFlag::operator int ( ) const

inline

Cast to int: same as value().

Returns

the SR flag value

Definition at line 54 of file EcalSrFlag.h.

References flag_.

{ return flag_; }

setValue()

void EcalSrFlag::setValue ( const int &  flag )

inline

Set the SR flag value. See SRF_XXX constants.

Parameters

flag	new flag value. Must be between 0 and 7.

Definition at line 49 of file EcalSrFlag.h.

References RemoveAddSevLevel::flag, and flag_.

Referenced by Types._ProxyParameter::__init__().

{ flag_ = (unsigned char)flag; }

value()

int EcalSrFlag::value ( ) const

inline

SR flag value. See SRF_XXX constants.

Returns

the flag value

Definition at line 44 of file EcalSrFlag.h.

References flag_.

Referenced by Types.int32::__nonzero__(), Types.uint32::__nonzero__(), Types.int64::__nonzero__(), Types.uint64::__nonzero__(), Types.double::__nonzero__(), Types.bool::__nonzero__(), Types.string::__nonzero__(), EcalSelectiveReadoutValidation::analyzeEB(), EcalSelectiveReadoutValidation::analyzeEE(), average.Average::average(), Types.string::configValue(), Types.FileInPath::configValue(), Mixins.UsingBlock::dumpPython(), Mixins.UsingBlock::insertInto(), Types.int32::insertInto(), Types.uint32::insertInto(), Types.int64::insertInto(), Types.uint64::insertInto(), Types.double::insertInto(), Types.bool::insertInto(), Types.string::insertInto(), Types.FileInPath::insertInto(), Types.vint32::insertInto(), Types.vuint32::insertInto(), Types.vint64::insertInto(), Types.vuint64::insertInto(), Types.vdouble::insertInto(), Types.vbool::insertInto(), Types.vstring::insertInto(), operator<<(), and EcalDigiToRaw::produce().

{ return flag_; }

Member Data Documentation

flag_

unsigned char EcalSrFlag::flag_

protected

The SRP flag.

Definition at line 70 of file EcalSrFlag.h.

Referenced by EBSrFlag::EBSrFlag(), EESrFlag::EESrFlag(), flagName(), operator int(), setValue(), and value().

SRF_FORCED_MASK

const int EcalSrFlag::SRF_FORCED_MASK = 0x4

static

Mask for the 'forced' bit which is set when the decision was forced by an error condition or by configuration.

E.g., a force full readout flag has value SRF_FORCED_MASK|SRF_FULL

Definition at line 29 of file EcalSrFlag.h.

Referenced by EcalSelectiveReadoutValidation::analyzeEB(), EcalSelectiveReadoutValidation::analyzeEE(), EcalDetIdToBeRecoveredProducer::produce(), ecaldqm::SelectiveReadoutTask::runOnDigis(), and ecaldqm::SelectiveReadoutTask::runOnSrFlags().

SRF_FULL

const int EcalSrFlag::SRF_FULL = 3

static

SRP flag for full readout of the readout unit.

Definition at line 24 of file EcalSrFlag.h.

Referenced by EcalSelectiveReadoutValidation::anaDigi(), EcalSelectiveReadoutValidation::analyzeEB(), EcalSelectiveReadoutValidation::analyzeEE(), EcalSelectiveReadoutValidation::checkSrApplication(), PFEcalBarrelRecHitCreator::isHighInterest(), PFEcalEndcapRecHitCreator::isHighInterest(), EcalDetIdToBeRecoveredProducer::produce(), ecaldqm::SelectiveReadoutTask::runOnDigis(), and ecaldqm::SelectiveReadoutTask::runOnSrFlags().

SRF_SUPPRESS

const int EcalSrFlag::SRF_SUPPRESS = 0

static

SRP flag for suppression of every channel of the readout unit.

Definition at line 15 of file EcalSrFlag.h.

SRF_ZS1

const int EcalSrFlag::SRF_ZS1 = 1

static

SRP flag for zero suppression with level 1.

Definition at line 18 of file EcalSrFlag.h.

Referenced by EcalSelectiveReadoutValidation::analyzeEB(), EcalSelectiveReadoutValidation::analyzeEE(), EcalSelectiveReadoutValidation::checkSrApplication(), ecaldqm::SelectiveReadoutTask::runOnDigis(), and ecaldqm::SelectiveReadoutTask::runOnSrFlags().

SRF_ZS2

const int EcalSrFlag::SRF_ZS2 = 2

static

SRP flag for zero suppression with level 2.

Definition at line 21 of file EcalSrFlag.h.

Referenced by EcalSelectiveReadoutValidation::checkSrApplication(), ecaldqm::SelectiveReadoutTask::runOnDigis(), and ecaldqm::SelectiveReadoutTask::runOnSrFlags().

srfNames

const char *const EcalSrFlag::srfNames

staticprivate

Initial value:

= {
    "Suppress",            
    "Zs1",                 
    "Zs2",                 
    "Full Readout",        
    "Forced Suppress",     
    "Forced Zs1",          
    "Forced Zs2",          
    "Forced Full Readout"  
}

Human readable flag value names

Definition at line 75 of file EcalSrFlag.h.

Referenced by flagName().