MCShowerCheckerOG::MCShowerChecker Class Reference

#include <MCShowerChecker.h>

Inheritance diagram for MCShowerCheckerOG::MCShowerChecker:

Public Types
enum	ResultFlag { eSuccess, eFailure, eBreakLoop, eContinueLoop }
	Flag returned by module methods to the RunController. More...
enum	VersionInfoType {   eFilename = 1, eRevisionNumber = 2, eDate = 3, eTime = 4,   eLastEditor = 5 }
	Different types of version info that can be retrieved from GetVersionInfo. More...

Public Member Functions
fwk::VModule::ResultFlag	Finish ()
	Finish: invoked at end of the run (NOT end of the event) More...
utl::Stopwatch &	GetStopwatch ()
const utl::Stopwatch &	GetStopwatch () const
std::string	GetVersionInfo (const VersionInfoType v) const
	Retrieve different sorts of module version info. More...
fwk::VModule::ResultFlag	Init ()
	Initialize: invoked at beginning of run (NOT beginning of event) More...
void	InitTiming ()
	MCShowerChecker ()
fwk::VModule::ResultFlag	Run (evt::Event &theEvent)
	Run: invoked once per event. More...
ResultFlag	RunWithTiming (evt::Event &event)
virtual	~MCShowerChecker ()

Static Public Member Functions
static std::string	GetResultFlagByName (const ResultFlag flag)

Protected Types
enum	InfoLevel { eInfoNone = 0, eInfoFinal = 1, eInfoIntermediate = 2, eInfoDebug = 3 }

Protected Attributes
int	fInfoLevel = 0

Private Types
enum	EHandle { eReject, eCorrect, eAssert }

Private Member Functions
	REGISTER_MODULE ("MCShowerCheckerOG", MCShowerChecker)
EHandle	ToEnum (const std::string &text) const
std::string	ToText (const EHandle flag) const

Private Attributes
EHandle	fElectronNumberProfile = eReject
int	fNEventsAccepted = 0
int	fNEventsProcessed = 0
int	fNEventsWithElectronProfileProblem = 0
int	fVerbose = 0

Detailed Description

Author

Ralf Ulrich

Date

Mon Mar 22 16:28:16 EDT 2010

Definition at line 19 of file MCShowerChecker.h.

Member Enumeration Documentation

enum MCShowerCheckerOG::MCShowerChecker::EHandle

private

Enumerator
eReject
eCorrect
eAssert

Definition at line 21 of file MCShowerChecker.h.

enum fwk::VModule::InfoLevel

protectedinherited

Enumerator
eInfoNone
eInfoFinal
eInfoIntermediate
eInfoDebug

Definition at line 125 of file VModule.h.

enum fwk::VModule::ResultFlag

inherited

Flag returned by module methods to the RunController.

Enumerator
eSuccess	Report success to RunController.
eFailure	Report failure to RunController, causing RunController to terminate execution.
eBreakLoop	Break current loop. It works for nested loops too!
eContinueLoop	Skip remaining modules in the current loop and continue with next iteration of the loop.

Definition at line 60 of file VModule.h.

enum fwk::VModule::VersionInfoType

inherited

Different types of version info that can be retrieved from GetVersionInfo.

Enumerator
eFilename
eRevisionNumber
eDate
eTime
eLastEditor

Definition at line 110 of file VModule.h.

Constructor & Destructor Documentation

MCShowerCheckerOG::MCShowerChecker::MCShowerChecker ( )

inline

Definition at line 28 of file MCShowerChecker.h.

virtual MCShowerCheckerOG::MCShowerChecker::~MCShowerChecker ( )

inlinevirtual

Definition at line 29 of file MCShowerChecker.h.

Member Function Documentation

VModule::ResultFlag MCShowerChecker::Finish ( )

virtual

Finish: invoked at end of the run (NOT end of the event)

This method is for things that should be done at the end of the run (for example, closing files or writing out histograms) {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 143 of file MCShowerChecker.cc.

References utl::endc, utl::endr, io::eSuccess, INFO, and tab.

std::string fwk::VModule::GetResultFlagByName ( const ResultFlag  flag )

staticinherited

Definition at line 8 of file VModule.cc.

References fwk::VModule::eBreakLoop, fwk::VModule::eContinueLoop, fwk::VModule::eFailure, and fwk::VModule::eSuccess.

Referenced by fwk::RunController::DoNextInSequence(), fwk::RunController::FinishBranch(), and fwk::RunController::InitBranch().

utl::Stopwatch& fwk::VModule::GetStopwatch ( )

inlineinherited

Definition at line 106 of file VModule.h.

References fwk::VModule::fStopwatch.

const utl::Stopwatch& fwk::VModule::GetStopwatch ( ) const

inlineinherited

Definition at line 107 of file VModule.h.

References fwk::VModule::fStopwatch.

std::string fwk::VModule::GetVersionInfo ( const VersionInfoType  v ) const

inherited

Retrieve different sorts of module version info.

Definition at line 26 of file VModule.cc.

Referenced by fwk::CentralConfig::GetConfig(), ThresholdCalculatorKG::ThresholdCalculator::Init(), fdDoubleBumpFinder::FdDoubleBumpFinder::Init(), LaserGeneratorNA::LaserGenerator::Init(), LaserLightSimulatorNA::LaserLightSimulator::Init(), FdElectronicsSimulatorOG::FdElectronicsSimulator::Init(), TelescopeSimulatorKG::TelescopeSimulator::Init(), TelescopeSimulatorKG2::TelescopeSimulator::Init(), SdSimpleSimKG::SdSimpleSim::Init(), ShowerPhotonGeneratorOG::ShowerPhotonGenerator::Init(), and testRunController::testModuleVersionInfo().

VModule::ResultFlag MCShowerChecker::Init ( )

virtual

Initialize: invoked at beginning of run (NOT beginning of event)

This method is for things that should be done once at the beginning of a run (for example, booking histograms, performing calculations that need to be done only once, initializing parameters) {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 38 of file MCShowerChecker.cc.

References io::eSuccess, utl::Branch::Get(), utl::Branch::GetChild(), utl::Branch::GetData(), and utl::Branch::GetTopBranch().

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

References fwk::VModule::fStopwatch, and utl::Stopwatch::Reset().

MCShowerCheckerOG::MCShowerChecker::REGISTER_MODULE ( "MCShowerCheckerOG"  , MCShowerChecker    )

private

VModule::ResultFlag MCShowerChecker::Run ( evt::Event &  event )

virtual

Run: invoked once per event.

This method is for things that should be done once per event {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 92 of file MCShowerChecker.cc.

References utl::cm2, ERROR, io::eSuccess, utl::g, evt::ShowerSimData::GetLongitudinalProfile(), utl::TabulatedFunction::GetNPoints(), utl::TabulatedFunction::GetX(), utl::TabulatedFunction::GetY(), evt::ShowerSimData::HasLongitudinalProfile(), evt::Event::HasSimShower(), and WARNING.

ResultFlag fwk::VModule::RunWithTiming ( evt::Event &  event )

inlineinherited

Definition at line 98 of file VModule.h.

References fwk::VModule::fStopwatch, fwk::VModule::Run(), utl::Stopwatch::Start(), and utl::Stopwatch::Stop().

Referenced by fwk::RunController::DoNextInSequence().

MCShowerChecker::EHandle MCShowerChecker::ToEnum ( const std::string &  text ) const

private

Definition at line 78 of file MCShowerChecker.cc.

std::string MCShowerChecker::ToText ( const EHandle  flag ) const

private

Definition at line 59 of file MCShowerChecker.cc.

Member Data Documentation

EHandle MCShowerCheckerOG::MCShowerChecker::fElectronNumberProfile = eReject

private

Definition at line 42 of file MCShowerChecker.h.

int fwk::VModule::fInfoLevel = 0

protectedinherited

Definition at line 123 of file VModule.h.

Referenced by RdChannelASCIINoiseImporterRD::RdChannelASCIINoiseImporterRD::Init(), Rd2dLDFFitter::Rd2dLDFFitter::Init(), RdChannelNoiseImporter_AERA::RdChannelNoiseImporter_AERA::Init(), and Rd2dLDFFitter::Rd2dLDFFitter::Run().

int MCShowerCheckerOG::MCShowerChecker::fNEventsAccepted = 0

private

Definition at line 45 of file MCShowerChecker.h.

int MCShowerCheckerOG::MCShowerChecker::fNEventsProcessed = 0

private

Definition at line 44 of file MCShowerChecker.h.

int MCShowerCheckerOG::MCShowerChecker::fNEventsWithElectronProfileProblem = 0

private

Definition at line 47 of file MCShowerChecker.h.

int MCShowerCheckerOG::MCShowerChecker::fVerbose = 0

private

Definition at line 40 of file MCShowerChecker.h.

---

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

• MCShowerChecker.h
• MCShowerChecker.cc