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

#include <RdCOREASSimulationCreator.h>

Inheritance diagram for RdCOREASSimulationCreator::RdCOREASSimulationCreator:
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

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

Static Public Member Functions

static std::string GetResultFlagByName (const ResultFlag flag)
 

Private Types

enum  InfoLevel {
  eNone = 0, eFinal = 1, eIntermediate = 2, eObscure = 3,
  eMinuit = 4, eDebug = 5
}
 

Private Member Functions

 REGISTER_MODULE ("RdCOREASSimulationCreator", RdCOREASSimulationCreator)
 

Private Attributes

string fCorsikaBinary
 
string fCorsikaDirectory
 
string fCorsikaUser
 
string fDataDirectory
 
string fFlukaDirectory
 
int fInfoLevel
 xml settings: info level (verbosity) More...
 
string fInputSource
 
vector< simparams * >::iterator fShowerIterator
 
vector< simparams * > fShowers
 

Detailed Description

Definition at line 32 of file RdCOREASSimulationCreator.h.

Member Enumeration Documentation

Enumerator
eNone 
eFinal 
eIntermediate 
eObscure 
eMinuit 
eDebug 

Definition at line 45 of file RdCOREASSimulationCreator.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

RdCOREASSimulationCreator::RdCOREASSimulationCreator::RdCOREASSimulationCreator ( )

Definition at line 41 of file RdCOREASSimulationCreator.cc.

RdCOREASSimulationCreator::RdCOREASSimulationCreator::~RdCOREASSimulationCreator ( )
virtual

Definition at line 46 of file RdCOREASSimulationCreator.cc.

Member Function Documentation

void RdCOREASSimulationCreator::RdCOREASSimulationCreator::CreateShower ( )
VModule::ResultFlag RdCOREASSimulationCreator::RdCOREASSimulationCreator::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 353 of file RdCOREASSimulationCreator.cc.

References fwk::VModule::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 RdCOREASSimulationCreator::RdCOREASSimulationCreator::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 50 of file RdCOREASSimulationCreator.cc.

References RdCOREASSimulationCreator::simparams::Azimuth, RdCOREASSimulationCreator::simparams::CoreX, RdCOREASSimulationCreator::simparams::CoreY, RdCOREASSimulationCreator::simparams::CoreZ, RdCOREASSimulationCreator::simparams::CorsikaBinary, RdCOREASSimulationCreator::simparams::CorsikaDirectory, RdCOREASSimulationCreator::simparams::DataDirectory, RdCOREASSimulationCreator::simparams::Energy, fwk::VModule::eSuccess, fCorsikaBinary, fCorsikaDirectory, fCorsikaUser, fDataDirectory, fFlukaDirectory, fInfoLevel, fInputSource, RdCOREASSimulationCreator::simparams::FlukaDirectory, fShowerIterator, fShowers, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetFirstChild(), utl::Branch::GetNextSibling(), utl::Branch::GetTopBranch(), INFO, RdCOREASSimulationCreator::simparams::PrimaryParticle, RdCOREASSimulationCreator::simparams::REASSeed, RdCOREASSimulationCreator::simparams::Run, RdCOREASSimulationCreator::simparams::Seed1, RdCOREASSimulationCreator::simparams::Seed2, RdCOREASSimulationCreator::simparams::Seed3, RdCOREASSimulationCreator::simparams::UTCDate, and RdCOREASSimulationCreator::simparams::Zenith.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

RdCOREASSimulationCreator::RdCOREASSimulationCreator::REGISTER_MODULE ( "RdCOREASSimulationCreator"  ,
RdCOREASSimulationCreator   
)
private
VModule::ResultFlag RdCOREASSimulationCreator::RdCOREASSimulationCreator::Run ( evt::Event event)
virtual
ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited
void RdCOREASSimulationCreator::RdCOREASSimulationCreator::WriteFiles ( )

Member Data Documentation

string RdCOREASSimulationCreator::RdCOREASSimulationCreator::fCorsikaBinary
private

Definition at line 58 of file RdCOREASSimulationCreator.h.

Referenced by Init().

string RdCOREASSimulationCreator::RdCOREASSimulationCreator::fCorsikaDirectory
private

Definition at line 57 of file RdCOREASSimulationCreator.h.

Referenced by Init().

string RdCOREASSimulationCreator::RdCOREASSimulationCreator::fCorsikaUser
private

Definition at line 62 of file RdCOREASSimulationCreator.h.

Referenced by Init(), and Run().

string RdCOREASSimulationCreator::RdCOREASSimulationCreator::fDataDirectory
private

Definition at line 60 of file RdCOREASSimulationCreator.h.

Referenced by Init().

string RdCOREASSimulationCreator::RdCOREASSimulationCreator::fFlukaDirectory
private

Definition at line 59 of file RdCOREASSimulationCreator.h.

Referenced by Init().

int RdCOREASSimulationCreator::RdCOREASSimulationCreator::fInfoLevel
private

xml settings: info level (verbosity)

Definition at line 55 of file RdCOREASSimulationCreator.h.

Referenced by Init().

string RdCOREASSimulationCreator::RdCOREASSimulationCreator::fInputSource
private

Definition at line 61 of file RdCOREASSimulationCreator.h.

Referenced by Init().

vector<simparams*>::iterator RdCOREASSimulationCreator::RdCOREASSimulationCreator::fShowerIterator
private

Definition at line 65 of file RdCOREASSimulationCreator.h.

Referenced by Init(), and Run().

vector<simparams*> RdCOREASSimulationCreator::RdCOREASSimulationCreator::fShowers
private

Definition at line 64 of file RdCOREASSimulationCreator.h.

Referenced by Init(), and Run().


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

, generated on Tue Sep 26 2023.