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
UnderGrdInjectorAG::UnderGrdInjector Class Reference

class that handles Geant4 underground propagation for AMIGA muon Counters More...

#include <MdUnderGrdInjector.h>

Inheritance diagram for UnderGrdInjectorAG::UnderGrdInjector:
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 ()
 
bool IsChargedParticle (mevt::ScintillatorSimData::ParticleIterator pIt)
 
bool IsNeutrino (mevt::ScintillatorSimData::ParticleIterator pIt)
 
fwk::VModule::ResultFlag Run (evt::Event &event)
 Run: invoked once per event. More...
 
ResultFlag RunWithTiming (evt::Event &event)
 
 UnderGrdInjector ()
 
virtual ~UnderGrdInjector ()
 

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

int GetTriggerTimeFromSD (evt::Event &event, const mdet::Counter &cmDet, double &T1)
 
 REGISTER_MODULE ("UnderGrdInjectorAG", UnderGrdInjector)
 

Private Attributes

bool fOnlyMuons
 
bool fUseT1FromSD
 

Static Private Attributes

static const double kTriggerDelay = 0.*utl::ns
 

Detailed Description

class that handles Geant4 underground propagation for AMIGA muon Counters

Author
F. Sanchez
Date
2 April 2011

Definition at line 43 of file MdUnderGrdInjector.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

UnderGrdInjector::UnderGrdInjector ( )

Definition at line 47 of file MdUnderGrdInjector.cc.

virtual UnderGrdInjectorAG::UnderGrdInjector::~UnderGrdInjector ( )
inlinevirtual

Definition at line 51 of file MdUnderGrdInjector.h.

Member Function Documentation

VModule::ResultFlag UnderGrdInjector::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 420 of file MdUnderGrdInjector.cc.

References fwk::VModule::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.

int UnderGrdInjector::GetTriggerTimeFromSD ( evt::Event event,
const mdet::Counter cmDet,
double &  T1 
)
private
std::string fwk::VModule::GetVersionInfo ( const VersionInfoType  v) const
inherited
VModule::ResultFlag UnderGrdInjector::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 54 of file MdUnderGrdInjector.cc.

References fwk::VModule::eSuccess, fOnlyMuons, fUseT1FromSD, utl::Branch::GetTopBranch(), INFO, and utl::LoadConfig().

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

bool UnderGrdInjector::IsChargedParticle ( mevt::ScintillatorSimData::ParticleIterator  pIt)

Definition at line 400 of file MdUnderGrdInjector.cc.

References cevt::StationConstants::ePhoton.

bool UnderGrdInjector::IsNeutrino ( mevt::ScintillatorSimData::ParticleIterator  pIt)

Definition at line 387 of file MdUnderGrdInjector.cc.

Referenced by Run().

UnderGrdInjectorAG::UnderGrdInjector::REGISTER_MODULE ( "UnderGrdInjectorAG"  ,
UnderGrdInjector   
)
private
VModule::ResultFlag UnderGrdInjector::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 68 of file MdUnderGrdInjector.cc.

References mevt::ScintillatorSimData::AddParticle(), mdet::FrontEnd::ChannelsBegin(), mdet::FrontEndSiPM::ChannelsBegin(), mdet::FrontEnd::ChannelsEnd(), mdet::FrontEndSiPM::ChannelsEnd(), mevt::MEvent::CountersBegin(), mevt::MEvent::CountersEnd(), fwk::VModule::eFailure, cevt::StationConstants::eMuon, ERROR, fwk::VModule::eSuccess, fOnlyMuons, fUseT1FromSD, mdet::MDetector::GetCounter(), mdet::Module::GetFrontEnd(), mdet::Module::GetFrontEndSiPM(), utl::TimeStamp::GetGPSNanoSecond(), utl::TimeStamp::GetGPSSecond(), mevt::Module::GetId(), det::MPositionable< Config >::GetLocalCoordinateSystem(), mdet::FrontEnd::GetMeanSampleRatePeriod(), mdet::FrontEndSiPM::GetMeanSampleRatePeriod(), mdet::Counter::GetModule(), mevt::CounterSimData::GetNumberOfUGrdParticles(), mdet::FrontEndSiPM::GetPostT1BufferLength(), mdet::FrontEnd::GetPostT1BufferLength(), mdet::FrontEndSiPM::GetPreT1BufferLength(), mdet::FrontEnd::GetPreT1BufferLength(), mevt::Module::GetScintillator(), mevt::Scintillator::GetSimData(), evt::ShowerSimData::GetTimeStamp(), GetTriggerTimeFromSD(), utl::Particle::GetType(), utl::BasicVector< HepVector >::GetX(), utl::BasicVector< HepVector >::GetY(), evt::Event::HasMEvent(), mevt::Module::HasScintillator(), evt::Event::HasSEvent(), mevt::Scintillator::HasSimData(), evt::Event::HasSimShower(), mevt::ScintillatorSimData::IncrementNumberOfInjectedMuons(), INFO, IsNeutrino(), mdet::Module::IsSiPM(), utl::m, mevt::Module::MakeScintillator(), mevt::Scintillator::MakeSimData(), max, mdet::Counter::ModulesBegin(), mdet::Counter::ModulesEnd(), utl::ns, utl::s, utl::Particle::SetPosition(), MdOptoElectronicSimulatorAG::SetTraceStartTime(), mevt::CounterSimData::UGrdParticlesBegin(), and mevt::CounterSimData::UGrdParticlesEnd().

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

Member Data Documentation

int fwk::VModule::fInfoLevel = 0
protectedinherited
bool UnderGrdInjectorAG::UnderGrdInjector::fOnlyMuons
private

Definition at line 46 of file MdUnderGrdInjector.h.

Referenced by Init(), and Run().

bool UnderGrdInjectorAG::UnderGrdInjector::fUseT1FromSD
private

Definition at line 47 of file MdUnderGrdInjector.h.

Referenced by Init(), and Run().

const double UnderGrdInjector::kTriggerDelay = 0.*utl::ns
staticprivate

Definition at line 61 of file MdUnderGrdInjector.h.


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

, generated on Tue Sep 26 2023.