List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes
Validatrix::Validatrix Class Reference
Inheritance diagram for Validatrix::Validatrix:
Inheritance graph
[legend]

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 () override
 Finish: invoked at end of the run (NOT end of the event) More...
 
utl::StopwatchGetStopwatch ()
 
const utl::StopwatchGetStopwatch () const
 
std::string GetVersionInfo (const VersionInfoType v) const
 Retrieve different sorts of module version info. More...
 
fwk::VModule::ResultFlag Init () override
 Initialize: invoked at beginning of run (NOT beginning of event) More...
 
void InitTiming ()
 
fwk::VModule::ResultFlag Run (evt::Event &event) override
 Run: invoked once per event. More...
 
ResultFlag RunWithTiming (evt::Event &event)
 
virtual ~Validatrix ()=default
 

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

 REGISTER_MODULE ("Validatrix", Validatrix)
 

Private Attributes

vector< CalibrationDigestfCurrentValues
 
unsigned int fLineNo = 0
 
ofstream fMuonBaseHistoFile
 
ofstream fMuonChargeHistoFile
 
ofstream fMuonPeakHistoFile
 
ofstream fMuonShapeHistoFile
 
vector< CalibrationDigestfReferenceValues
 
bool fStatus = true
 

Static Private Attributes

static const bool fDumpHistograms = true
 

Detailed Description

Definition at line 383 of file ValidationTests/SdCalibration/Validatrix.cc.

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.

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

virtual Validatrix::Validatrix::~Validatrix ( )
virtualdefault

Member Function Documentation

VModule::ResultFlag Validatrix::Validatrix::Finish ( )
overridevirtual

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 528 of file ValidationTests/SdCalibration/Validatrix.cc.

References ERROR, and io::eSuccess.

std::string fwk::VModule::GetResultFlagByName ( const ResultFlag  flag)
staticinherited
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
VModule::ResultFlag Validatrix::Validatrix::Init ( )
overridevirtual

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 409 of file ValidationTests/SdCalibration/Validatrix.cc.

References ERROR, io::eSuccess, and INFO.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

Validatrix::Validatrix::REGISTER_MODULE ( "Validatrix"  ,
Validatrix   
)
private
VModule::ResultFlag Validatrix::Validatrix::Run ( evt::Event event)
overridevirtual
ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited

Member Data Documentation

vector<CalibrationDigest> Validatrix::Validatrix::fCurrentValues
private

Definition at line 395 of file ValidationTests/SdCalibration/Validatrix.cc.

const bool Validatrix::Validatrix::fDumpHistograms = true
staticprivate

Definition at line 398 of file ValidationTests/SdCalibration/Validatrix.cc.

int fwk::VModule::fInfoLevel = 0
protectedinherited
unsigned int Validatrix::Validatrix::fLineNo = 0
private

Definition at line 392 of file ValidationTests/SdCalibration/Validatrix.cc.

ofstream Validatrix::Validatrix::fMuonBaseHistoFile
private

Definition at line 399 of file ValidationTests/SdCalibration/Validatrix.cc.

ofstream Validatrix::Validatrix::fMuonChargeHistoFile
private

Definition at line 400 of file ValidationTests/SdCalibration/Validatrix.cc.

ofstream Validatrix::Validatrix::fMuonPeakHistoFile
private

Definition at line 401 of file ValidationTests/SdCalibration/Validatrix.cc.

ofstream Validatrix::Validatrix::fMuonShapeHistoFile
private

Definition at line 402 of file ValidationTests/SdCalibration/Validatrix.cc.

vector<CalibrationDigest> Validatrix::Validatrix::fReferenceValues
private

Definition at line 394 of file ValidationTests/SdCalibration/Validatrix.cc.

bool Validatrix::Validatrix::fStatus = true
private

Definition at line 393 of file ValidationTests/SdCalibration/Validatrix.cc.


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

, generated on Tue Sep 26 2023.