SValidStore Class Reference

Module used to store reference information for validation of SD. More...

#include <SValidStore.h>

Inheritance diagram for SValidStore:

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 ()
fwk::VModule::ResultFlag	Run (evt::Event &event)
	Run: invoked once per event. More...
ResultFlag	RunWithTiming (evt::Event &event)
	SValidStore ()
virtual	~SValidStore ()

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 Member Functions
void	ExamineEvent (const evt::Event &event)
ValidationObj *	Factory (const std::string &ObjName)
void	RecInfo (const evt::Event &event)
	REGISTER_MODULE ("SValidStore", SValidStore)

Private Attributes
std::string	_Mode
std::map< std::string, ValidationObj * >	_ObjList
TValidationPtr *	_TvObjPtr
utl::Branch	_xmlSValidStore
TFile *	vOutputFile
TTree *	vReferenceTree

Detailed Description

Module used to store reference information for validation of SD.

Author

Daniele Martello

Date

Apr 2005

Definition at line 36 of file SValidStore.h.

Member Enumeration Documentation

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

SValidStore::SValidStore

(

)

Definition at line 61 of file SValidStore.cc.

SValidStore::~SValidStore ( )

virtual

Definition at line 69 of file SValidStore.cc.

References vOutputFile.

Member Function Documentation

void SValidStore::ExamineEvent ( const evt::Event &  event )

private

Definition at line 195 of file SValidStore.cc.

References evt::Event::HasRecShower(), and RecInfo().

ValidationObj * SValidStore::Factory ( const std::string &  ObjName )

private

Definition at line 215 of file SValidStore.cc.

Referenced by Init().

fwk::VModule::ResultFlag SValidStore::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 172 of file SValidStore.cc.

References _Mode, _ObjList, fwk::VModule::eFailure, fwk::VModule::eSuccess, ValidationObj::GetModuleName(), INFO, ValidationObj::IsValidate(), and vOutputFile.

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().

fwk::VModule::ResultFlag SValidStore::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 76 of file SValidStore.cc.

References _Mode, _ObjList, _TvObjPtr, _xmlSValidStore, fwk::VModule::eSuccess, Factory(), utl::Branch::GetChild(), utl::Branch::GetData(), fwk::CentralConfig::GetInstance(), fwk::CentralConfig::GetTopBranch(), utl::m, and vOutputFile.

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

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

void SValidStore::RecInfo ( const evt::Event &  event )

private

Definition at line 210 of file SValidStore.cc.

Referenced by ExamineEvent().

SValidStore::REGISTER_MODULE ( "SValidStore"  , SValidStore    )

private

fwk::VModule::ResultFlag SValidStore::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 114 of file SValidStore.cc.

References _Mode, _ObjList, _TvObjPtr, TValidationObj::Dump(), fwk::VModule::eFailure, fwk::VModule::eSuccess, ValidationObj::Fill(), ValidationObj::GetModuleName(), ValidationObj::GetTObject(), TValidationPtr::GetTVObj(), INFO, TValidationPtr::SetTVObj(), ValidationObj::SetValidationOk(), ValidationObj::Validate(), and vOutputFile.

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().

Member Data Documentation

std::string SValidStore::_Mode

private

Definition at line 52 of file SValidStore.h.

Referenced by Finish(), Init(), and Run().

std::map<std::string, ValidationObj*> SValidStore::_ObjList

private

Definition at line 49 of file SValidStore.h.

Referenced by Finish(), Init(), and Run().

TValidationPtr* SValidStore::_TvObjPtr

private

Definition at line 51 of file SValidStore.h.

Referenced by Init(), and Run().

utl::Branch SValidStore::_xmlSValidStore

private

Definition at line 50 of file SValidStore.h.

Referenced by Init().

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().

TFile* SValidStore::vOutputFile

private

Definition at line 47 of file SValidStore.h.

Referenced by Finish(), Init(), Run(), and ~SValidStore().

TTree* SValidStore::vReferenceTree

private

Definition at line 48 of file SValidStore.h.

---

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

• SValidStore.h
• SValidStore.cc