List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Attributes | Private Member Functions | Private Attributes
RdEVASimPreparator::RdEVASimPreparator Class Reference

#include <RdEVASimPreparator.h>

Inheritance diagram for RdEVASimPreparator::RdEVASimPreparator:
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 ()
 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 ()
 Initialize: invoked at beginning of run (NOT beginning of event) More...
 
void InitTiming ()
 
 RdEVASimPreparator ()
 
fwk::VModule::ResultFlag Run (evt::Event &theevent)
 Run: invoked once per event. More...
 
ResultFlag RunWithTiming (evt::Event &event)
 
 ~RdEVASimPreparator ()
 

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

std::string CreateBashScriptEVASim ()
 
std::string EVAFileWriter (evt::ShowerRecData &show, const evt::Header &head, evt::Event &theevent)
 
 REGISTER_MODULE ("RdEVASimPreparator", RdEVASimPreparator)
 

Private Attributes

ECoreZPosition fCoreZPosition
 
double fElectricField
 
std::string fEVAbin
 
std::string fEVAExecutableName
 
utl::Vector fMagneticField
 
double fMaxAntennaDistanceFromCore
 
std::string fPathToEVA
 
Eprimary fPrim
 
bool fUseMGMR
 
std::string fUserName
 
std::string fWorkingDir
 

Detailed Description

Definition at line 27 of file RdEVASimPreparator.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.

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

RdEVASimPreparator::RdEVASimPreparator::RdEVASimPreparator ( )
RdEVASimPreparator::RdEVASimPreparator::~RdEVASimPreparator ( )

Definition at line 105 of file RdEVASimPreparator.cc.

Member Function Documentation

string RdEVASimPreparator::RdEVASimPreparator::CreateBashScriptEVASim ( )
private

Definition at line 289 of file RdEVASimPreparator.cc.

Referenced by Run().

string RdEVASimPreparator::RdEVASimPreparator::EVAFileWriter ( evt::ShowerRecData show,
const evt::Header head,
evt::Event theevent 
)
private
VModule::ResultFlag RdEVASimPreparator::RdEVASimPreparator::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 149 of file RdEVASimPreparator.cc.

References io::eSuccess, and INFO.

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 RdEVASimPreparator::RdEVASimPreparator::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 108 of file RdEVASimPreparator.cc.

References RdEVASimPreparator::eAERA, RdEVASimPreparator::eAuto, RdEVASimPreparator::eIron, RdEVASimPreparator::eMAXIMA, RdEVASimPreparator::eProton, io::eSuccess, fCoreZPosition, fElectricField, fEVAbin, fMaxAntennaDistanceFromCore, fPathToEVA, fPrim, fUseMGMR, fUserName, fWorkingDir, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), and INFO.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

RdEVASimPreparator::RdEVASimPreparator::REGISTER_MODULE ( "RdEVASimPreparator"  ,
RdEVASimPreparator   
)
private
VModule::ResultFlag RdEVASimPreparator::RdEVASimPreparator::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 135 of file RdEVASimPreparator.cc.

References CreateBashScriptEVASim(), io::eSuccess, EVAFileWriter(), evt::Event::GetHeader(), and evt::Event::GetRecShower().

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

Member Data Documentation

ECoreZPosition RdEVASimPreparator::RdEVASimPreparator::fCoreZPosition
private

Definition at line 51 of file RdEVASimPreparator.h.

Referenced by EVAFileWriter(), and Init().

double RdEVASimPreparator::RdEVASimPreparator::fElectricField
private

Definition at line 44 of file RdEVASimPreparator.h.

Referenced by Init().

std::string RdEVASimPreparator::RdEVASimPreparator::fEVAbin
private

Definition at line 42 of file RdEVASimPreparator.h.

Referenced by Init().

std::string RdEVASimPreparator::RdEVASimPreparator::fEVAExecutableName
private

Definition at line 40 of file RdEVASimPreparator.h.

int fwk::VModule::fInfoLevel = 0
protectedinherited
utl::Vector RdEVASimPreparator::RdEVASimPreparator::fMagneticField
private

Definition at line 46 of file RdEVASimPreparator.h.

Referenced by EVAFileWriter(), and RdEVASimPreparator().

double RdEVASimPreparator::RdEVASimPreparator::fMaxAntennaDistanceFromCore
private

Definition at line 45 of file RdEVASimPreparator.h.

Referenced by EVAFileWriter(), and Init().

std::string RdEVASimPreparator::RdEVASimPreparator::fPathToEVA
private

Definition at line 41 of file RdEVASimPreparator.h.

Referenced by Init().

Eprimary RdEVASimPreparator::RdEVASimPreparator::fPrim
private

Definition at line 50 of file RdEVASimPreparator.h.

Referenced by EVAFileWriter(), and Init().

bool RdEVASimPreparator::RdEVASimPreparator::fUseMGMR
private

Definition at line 48 of file RdEVASimPreparator.h.

Referenced by EVAFileWriter(), and Init().

std::string RdEVASimPreparator::RdEVASimPreparator::fUserName
private

Definition at line 39 of file RdEVASimPreparator.h.

Referenced by Init().

std::string RdEVASimPreparator::RdEVASimPreparator::fWorkingDir
private

Definition at line 38 of file RdEVASimPreparator.h.

Referenced by EVAFileWriter(), and Init().


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

, generated on Tue Sep 26 2023.