Inheritance diagram for artg4tk::artg4tkMain:

Public Types
using	ModuleType = EDProducer

template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >

Public Member Functions
	artg4tkMain (fhicl::ParameterSet const &p)

virtual	~artg4tkMain ()

void	produce (art::Event &e) override

void	beginJob () override

void	beginRun (art::Run &r) override

void	endRun (art::Run &) override

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

void	fillProductDescriptions ()

void	registerProducts (ProductDescriptions &productsToRegister)

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Protected Member Functions
ConsumesCollector &	consumesCollector ()

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Private Attributes
unique_ptr< ArtG4RunManager >	runManager_

G4UIsession *	session_

G4UImanager *	UI_

long	seed_

string	macroPath_

cet::search_path	pathFinder_

string	visMacro_

bool	pauseAfterEvent_

bool	visSpecificEvents_

std::map< int, bool >	eventsToDisplay_

int	rmvlevel_

bool	uiAtBeginRun_

bool	uiAtEndEvent_

std::string	afterEvent_

mf::LogInfo	logInfo_

Detailed Description

Definition at line 45 of file artg4Main_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 17 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::detail::Producer::Table = Modifier::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 26 of file Producer.h.

Constructor & Destructor Documentation

artg4tk::artg4tkMain::artg4tkMain ( fhicl::ParameterSet const & p )

explicit

Definition at line 132 of file artg4Main_module.cc.

References afterEvent_, art::detail::EngineCreator::createEngine(), eventsToDisplay_, fhicl::ParameterSet::get(), pauseAfterEvent_, art::ProductRegistryHelper::producesCollector(), seed_, uiAtEndEvent_, and visSpecificEvents_.

   : art::EDProducer(p)
   , runManager_()
   , session_(0)
   , UI_(0)
   , seed_(p.get<long>("seed", -1))
   , macroPath_(p.get<std::string>("macroPath", "."))
   , pathFinder_(macroPath_)
   , visMacro_(p.get<std::string>("visMacro", "vis.mac"))
   , pauseAfterEvent_(false)
   , visSpecificEvents_(p.get<bool>("visualizeSpecificEvents", false))
   , eventsToDisplay_()
   , rmvlevel_(p.get<int>("rmvlevel", 0))
   , uiAtBeginRun_(p.get<bool>("uiAtBeginRun", false))
   , uiAtEndEvent_(false)
   , afterEvent_(p.get<std::string>("afterEvent", "pass"))
   , logInfo_("ArtG4Main")
 {
   // If we're in "visualize specific events" mode (essentially only pause
   // after given events), then extract the list of events we need to
   // pause for. They are placed in a map because it is more efficient to
   // determine whether a given entry is present in the map than a vector.
   if (visSpecificEvents_) {
     std::vector<int> eventsToDisplayVec = p.get<vector<int>>("eventsToDisplay");
     for (size_t i = 0; i < eventsToDisplayVec.size(); i++) {
       eventsToDisplay_[eventsToDisplayVec[i]] = true;
     }
     // Would be nice to have error checking here, but for now, if you
     // do something silly, it'll probably just crash.
   }
 
   // We need all of the services to run @produces@ on the data they will store. We do this
   // by retrieving the holder services.
   art::ServiceHandle<ActionHolderService> actionHolder;
   art::ServiceHandle<DetectorHolderService> detectorHolder;
   detectorHolder->initialize();
   // hjw:
   // detectorHolder -> callArtProduces(this);
   // Build the detectors' logical volumes
   detectorHolder->constructAllLVs();
   // And running @callArtProduces@ on each
   actionHolder->callArtProduces(producesCollector());
   detectorHolder->callArtProduces(producesCollector());
 
   // Set up the random number engine.
   // See the documentation in RandomNumberHeader.h for
   // how this works. Note that @createEngine@ is a member function
   // of our base class (actually, a couple of base classes deep!).
   // Note that the name @G4Engine@ is special.
   if (seed_ == -1) {
     // Construct seed from time and pid. (default behavior if
     // no seed is provided by the fcl file)
     // Note: According to Kevin Lynch, the two lines below are not portable.
     seed_ = time(0) + getpid();
     seed_ =
       ((seed_ & 0xFFFF0000) >> 16) | ((seed_ & 0x0000FFFF) << 16); // exchange upper and lower word
     seed_ = seed_ % 900000000; // ensure the seed is in the correct range for createEngine
   }
   createEngine(seed_, "G4Engine");
 
   // Handle the afterEvent setting
   if (afterEvent_ == "ui") {
     uiAtEndEvent_ = true;
   } else if (afterEvent_ == "pause") {
     pauseAfterEvent_ = true;
   }
 }

artg4tk::artg4tkMain::~artg4tkMain ( )

virtual

Definition at line 202 of file artg4Main_module.cc.

202 {}

Member Function Documentation

void artg4tk::artg4tkMain::beginJob ( )

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 207 of file artg4Main_module.cc.

References runManager_.

 {
   // Set up run manager
   mf::LogDebug("Main_Run_Manager") << "In begin job";
   runManager_.reset(new ArtG4RunManager);
 }

void artg4tk::artg4tkMain::beginRun ( art::Run & r )

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 217 of file artg4Main_module.cc.

References art::ServiceHandle< T, SCOPE >::get(), art::Run::id(), art::RunID::run(), runManager_, session_, UI_, and uiAtBeginRun_.

 {
   // Get the physics list and pass it to Geant4and initialize the list if necessary
   art::ServiceHandle<PhysicsListHolderService> physicsListHolder;
   runManager_->SetUserInitialization(physicsListHolder->makePhysicsList());
 
   // Get all of the detectors and initialize them
   art::ServiceHandle<DetectorHolderService> detectorHolder;
 
   // Declare the detector construction to Geant
   runManager_->SetUserInitialization(
     new ArtG4DetectorConstruction{detectorHolder->worldPhysicalVolume()});
 
   // Get all of the actions and initialize them
   art::ServiceHandle<ActionHolderService> actionHolder;
   actionHolder->initialize();
 
   // Store the run in the action holder
   actionHolder->setCurrArtRun(r);
 
   // Declare the primary generator action to Geant
   runManager_->SetUserAction(new ArtG4PrimaryGeneratorAction{actionHolder.get()});
 
   // Note that these actions (and ArtG4PrimaryGeneratorAction above) are all
   // generic actions that really don't do much on their own. Rather, to
   // use the power of actions, one must create action objects (derived from
   // @ActionBase@) and register them with the Art @ActionHolder@ service.
   // See @ActionBase@ and/or @ActionHolderService@ for more information.
   runManager_->SetUserAction(new ArtG4SteppingAction{actionHolder.get()});
   runManager_->SetUserAction(new ArtG4StackingAction{actionHolder.get()});
   runManager_->SetUserAction(new ArtG4EventAction{actionHolder.get(), detectorHolder.get()});
   runManager_->SetUserAction(new ArtG4TrackingAction{actionHolder.get()});
 
   runManager_->Initialize();
   physicsListHolder->initializePhysicsList();
 
   // get the pointer to the User Interface manager
   UI_ = G4UImanager::GetUIpointer();
   // Open a UI if asked
   if (uiAtBeginRun_) {
     session_ = new G4UIterminal;
     session_->SessionStart();
     delete session_;
   }
 
   // Start the Geant run!
   runManager_->BeamOnBeginRun(r.id().run());
 }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Producer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 22 of file Producer.cc.

References art::detail::Producer::beginJobWithFrame(), and art::detail::Producer::setupQueues().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Producer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 65 of file Producer.cc.

References art::detail::Producer::beginRunWithFrame(), art::RangeSet::forRun(), art::RunPrincipal::makeRun(), r, art::RunPrincipal::runID(), and art::ModuleContext::scheduleID().

   {
     auto r = rp.makeRun(mc, RangeSet::forRun(rp.runID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

bool art::detail::Producer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 85 of file Producer.cc.

References art::detail::Producer::beginSubRunWithFrame(), art::RangeSet::forSubRun(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::SubRunPrincipal::subRunID().

   {
     auto sr = srp.makeSubRun(mc, RangeSet::forSubRun(srp.subRunID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

void art::detail::Producer::doEndJob ( )

inherited

Definition at line 30 of file Producer.cc.

References art::detail::Producer::endJobWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Producer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 75 of file Producer.cc.

References art::detail::Producer::endRunWithFrame(), art::RunPrincipal::makeRun(), r, art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto r = rp.makeRun(mc, rp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

bool art::detail::Producer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 95 of file Producer.cc.

References art::detail::Producer::endSubRunWithFrame(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto sr = srp.makeSubRun(mc, srp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

bool art::detail::Producer::doEvent	(	EventPrincipal &	ep,
		ModuleContext const &	mc,
		std::atomic< std::size_t > &	counts_run,
		std::atomic< std::size_t > &	counts_passed,
		std::atomic< std::size_t > &	counts_failed
	)

inherited

Definition at line 105 of file Producer.cc.

References art::detail::Producer::checkPutProducts_, e, art::EventPrincipal::makeEvent(), art::detail::Producer::produceWithFrame(), and art::ModuleContext::scheduleID().

   {
     auto e = ep.makeEvent(mc);
     ++counts_run;
     ProcessingFrame const frame{mc.scheduleID()};
     produceWithFrame(e, frame);
     e.commitProducts(checkPutProducts_, &expectedProducts<InEvent>());
     ++counts_passed;
     return true;
   }

void art::detail::Producer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 44 of file Producer.cc.

References art::detail::Producer::respondToCloseInputFileWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 58 of file Producer.cc.

References art::detail::Producer::respondToCloseOutputFilesWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 37 of file Producer.cc.

References art::detail::Producer::respondToOpenInputFileWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 51 of file Producer.cc.

References art::detail::Producer::respondToOpenOutputFilesWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

void artg4tk::artg4tkMain::endRun ( art::Run & r )

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 290 of file artg4Main_module.cc.

References DEFINE_ART_MODULE, and runManager_.

 {
   art::ServiceHandle<ActionHolderService> actionHolder;
   actionHolder->setCurrArtRun(r);
 
   runManager_->BeamOnEndRun();
 }

void art::Modifier::fillProductDescriptions ( )

inherited

Definition at line 10 of file Modifier.cc.

References art::ProductRegistryHelper::fillDescriptions(), and art::ModuleBase::moduleDescription().

   {
     ProductRegistryHelper::fillDescriptions(moduleDescription());
   }

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

void artg4tk::artg4tkMain::produce ( art::Event & e )

overridevirtual

Implements art::EDProducer.

Definition at line 269 of file artg4Main_module.cc.

References art::EventID::event(), art::Event::id(), logInfo_, and runManager_.

 {
   // The holder services need the event
   art::ServiceHandle<ActionHolderService> actionHolder;
   art::ServiceHandle<DetectorHolderService> detectorHolder;
 
   actionHolder->setCurrArtEvent(e);
   detectorHolder->setCurrArtEvent(e);
 
   // Begin event
   runManager_->BeamOnDoOneEvent(e.id().event());
 
   logInfo_ << "Producing event " << e.id().event() << "\n" << endl;
 
   // Done with the event
   runManager_->BeamOnEndEvent();
 }

void art::Modifier::registerProducts ( ProductDescriptions & productsToRegister )

inherited

Definition at line 16 of file Modifier.cc.

References art::ModuleBase::moduleDescription(), and art::ProductRegistryHelper::registerProducts().

   {
     ProductRegistryHelper::registerProducts(productsToRegister,
                                             moduleDescription());
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

Member Data Documentation

std::string artg4tk::artg4tkMain::afterEvent_

private

Definition at line 123 of file artg4Main_module.cc.

Referenced by artg4tkMain().

std::map<int, bool> artg4tk::artg4tkMain::eventsToDisplay_

private

Definition at line 109 of file artg4Main_module.cc.

Referenced by artg4tkMain().

mf::LogInfo artg4tk::artg4tkMain::logInfo_

private

Definition at line 126 of file artg4Main_module.cc.

Referenced by produce().

string artg4tk::artg4tkMain::macroPath_

private

Definition at line 81 of file artg4Main_module.cc.

cet::search_path artg4tk::artg4tkMain::pathFinder_

private

Definition at line 85 of file artg4Main_module.cc.

bool artg4tk::artg4tkMain::pauseAfterEvent_

private

Definition at line 95 of file artg4Main_module.cc.

Referenced by artg4tkMain().

int artg4tk::artg4tkMain::rmvlevel_

private

Definition at line 112 of file artg4Main_module.cc.

unique_ptr<ArtG4RunManager> artg4tk::artg4tkMain::runManager_

private

Definition at line 61 of file artg4Main_module.cc.

Referenced by beginJob(), beginRun(), endRun(), and produce().

long artg4tk::artg4tkMain::seed_

private

Definition at line 71 of file artg4Main_module.cc.

Referenced by artg4tkMain().

G4UIsession* artg4tk::artg4tkMain::session_

private

Definition at line 64 of file artg4Main_module.cc.

Referenced by beginRun().

G4UImanager* artg4tk::artg4tkMain::UI_

private

Definition at line 65 of file artg4Main_module.cc.

Referenced by beginRun().

bool artg4tk::artg4tkMain::uiAtBeginRun_

private

Definition at line 115 of file artg4Main_module.cc.

Referenced by beginRun().

bool artg4tk::artg4tkMain::uiAtEndEvent_

private

Definition at line 116 of file artg4Main_module.cc.

Referenced by artg4tkMain().

string artg4tk::artg4tkMain::visMacro_

private

Definition at line 89 of file artg4Main_module.cc.

bool artg4tk::artg4tkMain::visSpecificEvents_

private

Definition at line 102 of file artg4Main_module.cc.

Referenced by artg4tkMain().

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

artg4tk/v12_00_03/source/artg4tk/Core/artg4Main_module.cc

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation