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

simulates a shower with conex (energy, primary and direction are taken from ShowerSimData More...

#include <ConexShowerGenerator.h>

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

 ConexShowerGenerator ()
 
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)
 
virtual ~ConexShowerGenerator ()
 

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 ("ConexShowerGeneratorKG", ConexShowerGenerator)
 

Private Attributes

ConexInterface * fConexInterface = nullptr
 
double fMaxHeight = 0
 
double fMaxXmax = 0
 
double fMinXmax = 0
 
bool fPropagateAltitude = false
 
bool fRandomDistance = false
 
bool fRandomXmax = false
 
int fRecycle = 0
 
int fShowerCounter = 0
 
int fStoredGenerations = 0
 
int fStoredNLParticles = 0
 
int fStoredParticles = 0
 

Detailed Description

simulates a shower with conex (energy, primary and direction are taken from ShowerSimData

Author
Michael Unger
Date
4 May 2010

Definition at line 25 of file ConexShowerGenerator.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

ConexShowerGeneratorKG::ConexShowerGenerator::ConexShowerGenerator ( )
inline

Definition at line 28 of file ConexShowerGenerator.h.

ConexShowerGenerator::~ConexShowerGenerator ( )
virtual

Definition at line 304 of file ConexShowerGenerator.cc.

Member Function Documentation

VModule::ResultFlag ConexShowerGenerator::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 295 of file ConexShowerGenerator.cc.

References io::eSuccess.

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 ConexShowerGenerator::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 64 of file ConexShowerGenerator.cc.

References utl::cm2, ERROR, io::eSuccess, utl::g, utl::Branch::Get(), utl::Branch::GetChild(), utl::Branch::GetData(), utl::RandomEngine::GetEngine(), fwk::CentralConfig::GetTopBranch(), INFO, and utl::m.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

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

References utl::cm2, ConexParticleNumber(), utl::deg, degree, ERROR, io::eSuccess, galactic::eV, atm::Atmosphere::EvaluateSlantDepthVsDistance(), io::CONEXHeader::fHighEnergyModel, io::FillShowerProfileDataFromConex(), io::CONEXHeader::fROOTVersion, io::CONEXHeader::fSeed, io::CONEXHeader::fVersion, io::CONEXShower::fXfirst, io::CONEXShower::fXmax, utl::g, evt::ShowerSimData::GetDirection(), evt::ShowerSimData::GetEnergy(), utl::RandomEngine::GetEngine(), evt::ShowerSimData::GetGHParameters(), evt::ShowerSimData::GetLocalCoordinateSystem(), evt::ShowerSimData::GetLongitudinalProfile(), utl::TabulatedFunction::GetNPoints(), evt::ShowerSimData::GetPosition(), evt::ShowerSimData::GetPrimaryParticle(), evt::VGaisserHillasParameter::GetXMax(), utl::GeV, evt::ShowerSimData::HasGHParameters(), evt::ShowerSimData::HasLongitudinalProfile(), evt::Event::HasSimShower(), INFO, atm::Atmosphere::InitSlantProfileModel(), galactic::meter, utl::ReferenceEllipsoid::PointToLatitudeLongitudeHeight(), evt::ShowerSimData::SetShowerNumber(), evt::ShowerSimData::SetShowerRunId(), and atm::ProfileResult::Y().

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

ConexInterface* ConexShowerGeneratorKG::ConexShowerGenerator::fConexInterface = nullptr
private

Definition at line 47 of file ConexShowerGenerator.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().

double ConexShowerGeneratorKG::ConexShowerGenerator::fMaxHeight = 0
private

Definition at line 43 of file ConexShowerGenerator.h.

double ConexShowerGeneratorKG::ConexShowerGenerator::fMaxXmax = 0
private

Definition at line 42 of file ConexShowerGenerator.h.

double ConexShowerGeneratorKG::ConexShowerGenerator::fMinXmax = 0
private

Definition at line 41 of file ConexShowerGenerator.h.

bool ConexShowerGeneratorKG::ConexShowerGenerator::fPropagateAltitude = false
private

Definition at line 37 of file ConexShowerGenerator.h.

bool ConexShowerGeneratorKG::ConexShowerGenerator::fRandomDistance = false
private

Definition at line 40 of file ConexShowerGenerator.h.

bool ConexShowerGeneratorKG::ConexShowerGenerator::fRandomXmax = false
private

Definition at line 39 of file ConexShowerGenerator.h.

int ConexShowerGeneratorKG::ConexShowerGenerator::fRecycle = 0
private

Definition at line 36 of file ConexShowerGenerator.h.

int ConexShowerGeneratorKG::ConexShowerGenerator::fShowerCounter = 0
private

Definition at line 38 of file ConexShowerGenerator.h.

int ConexShowerGeneratorKG::ConexShowerGenerator::fStoredGenerations = 0
private

Definition at line 44 of file ConexShowerGenerator.h.

int ConexShowerGeneratorKG::ConexShowerGenerator::fStoredNLParticles = 0
private

Definition at line 46 of file ConexShowerGenerator.h.

int ConexShowerGeneratorKG::ConexShowerGenerator::fStoredParticles = 0
private

Definition at line 45 of file ConexShowerGenerator.h.

The documentation for this class was generated from the following files:
, generated on Tue Sep 26 2023.