Inheritance diagram for larg4::larg4Main:

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

	~larg4Main ()

Public Member Functions inherited from art::EDProducer
	EDProducer (fhicl::ParameterSet const &pset)

template<typename Config >
	EDProducer (Table< Config > const &config)

std::string	workerType () const

Public Member Functions inherited from art::detail::Producer
virtual	~Producer () noexcept

	Producer (fhicl::ParameterSet const &)

	Producer (Producer const &)=delete

	Producer (Producer &&)=delete

Producer &	operator= (Producer const &)=delete

Producer &	operator= (Producer &&)=delete

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)

Public Member Functions inherited from art::Modifier
	~Modifier () noexcept

	Modifier ()

	Modifier (Modifier const &)=delete

	Modifier (Modifier &&)=delete

Modifier &	operator= (Modifier const &)=delete

Modifier &	operator= (Modifier &&)=delete

Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept

	ModuleBase ()

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)

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

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

Private Member Functions
void	produce (art::Event &e) override

void	beginJob () override

void	beginRun (art::Run &r) override

void	endRun (art::Run &) override

std::vector< art::Handle< MCTruthCollection > >	inputCollections (art::Event const &e) const

Private Attributes
G4UIsession *	session_ {nullptr}

G4UImanager *	UI_ {nullptr}

long	seed_

std::string	macroPath_

cet::search_path	pathFinder_

std::string	g4MacroFile_

std::vector< art::InputTag >	inputCollectionTags_

bool	pauseAfterEvent_ {false}

int	rmvlevel_

bool	uiAtBeginRun_

bool	uiAtEndEvent_ {false}

std::string	afterEvent_

Static Private Attributes
static std::unique_ptr< artg4tk::ArtG4RunManager >	runManager_ {nullptr}

static bool	initializeDetectors_ {true}

static std::atomic< int >	processingRun_ {0}

Additional Inherited Members
Public Types inherited from art::EDProducer
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >

Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Static Public Member Functions inherited from art::EDProducer
static void	commitEvent (EventPrincipal &ep, Event &e)

Protected Member Functions inherited from art::ModuleBase
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 ()

Detailed Description

Definition at line 52 of file larg4Main_module.cc.

Constructor & Destructor Documentation

larg4::larg4Main::larg4Main ( fhicl::ParameterSet const & p )

explicit

Definition at line 124 of file larg4Main_module.cc.

   : EDProducer{p}
   , seed_(p.get<long>("seed", -1))
   , macroPath_(p.get<std::string>("macroPath", "FW_SEARCH_PATH"))
   , pathFinder_(macroPath_)
   , g4MacroFile_(p.get<std::string>("visMacro", "larg4.mac"))
   , inputCollectionTags_{p.get<std::vector<art::InputTag>>("inputCollections", {})}
   , rmvlevel_(p.get<int>("rmvlevel", 0))
   , uiAtBeginRun_(p.get<bool>("uiAtBeginRun", false))
   , afterEvent_(p.get<std::string>("afterEvent", "pass"))
 {
   produces<std::vector<simb::MCParticle>>();
   produces<art::Assns<simb::MCTruth, simb::MCParticle, sim::GeneratedParticleInfo>>();
 
   // 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<artg4tk::ActionHolderService> actionHolder;
   art::ServiceHandle<artg4tk::DetectorHolderService> detectorHolder;
 
   if (initializeDetectors_) {
     detectorHolder->initialize();
     // Build the detectors' logical volumes
     detectorHolder->constructAllLVs();
     initializeDetectors_ = false;
   }
 
   // And running @callArtProduces@ on each
   actionHolder->callArtProduces(producesCollector());
   detectorHolder->callArtProduces(producesCollector());
 
   // -- Check for invalid seed value
   if (seed_ > 900000000) {
     throw cet::exception("largeant:BadSeedValue")
       << "The provided largeant seed value: " << seed_ << " is invalid! Maximum seed value is 9E8.";
   }
   // Set up the random number engine.
   // -- D.R.: Use the NuRandomService engine for additional control over the seed generation policy
   (void)art::ServiceHandle<rndm::NuRandomService>()->createEngine(*this, "G4Engine", p, "seed");
 
   // Handle the afterEvent setting
   if (afterEvent_ == "ui") { uiAtEndEvent_ = true; }
   else if (afterEvent_ == "pause") {
     pauseAfterEvent_ = true;
   }
 }

larg4::larg4Main::~larg4Main ( )

Definition at line 170 of file larg4Main_module.cc.

 {
   if (runManager_) {
     runManager_.reset();
   }
 }

Member Function Documentation

void larg4::larg4Main::beginJob ( )

overrideprivatevirtual

Reimplemented from art::EDProducer.

Definition at line 178 of file larg4Main_module.cc.

 {
   mf::LogDebug("Main_Run_Manager") << "In begin job";
   if (runManager_) {
     return;
   }
   runManager_.reset(new artg4tk::ArtG4RunManager);
 }

void larg4::larg4Main::beginRun ( art::Run & r )

overrideprivatevirtual

Reimplemented from art::EDProducer.

Definition at line 188 of file larg4Main_module.cc.

 {
   if (processingRun_++ != 0) {
     return;
   }
 
   // Get the physics list and pass it to Geant and initialize the list if necessary
   art::ServiceHandle<artg4tk::PhysicsListHolderService const> physicsListHolder;
   runManager_->SetUserInitialization(physicsListHolder->makePhysicsList());
 
   // Get all of the detectors and initialize them
   // Declare the detector construction to Geant
   auto detectorHolder = art::ServiceHandle<artg4tk::DetectorHolderService>().get();
   runManager_->SetUserInitialization(
     new artg4tk::ArtG4DetectorConstruction{detectorHolder->worldPhysicalVolume()});
 
   // Get all of the actions and initialize them
   auto actionHolder = art::ServiceHandle<artg4tk::ActionHolderService>().get();
   actionHolder->initialize();
 
   // Store the run in the action holder
   actionHolder->setCurrArtRun(r);
 
   // Declare the primary generator action to Geant
   runManager_->SetUserAction(new artg4tk::ArtG4PrimaryGeneratorAction{actionHolder});
 
   // 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 artg4tk::ArtG4SteppingAction{actionHolder});
   runManager_->SetUserAction(new artg4tk::ArtG4StackingAction{actionHolder});
   runManager_->SetUserAction(new artg4tk::ArtG4EventAction{actionHolder, detectorHolder});
   runManager_->SetUserAction(new artg4tk::ArtG4TrackingAction{actionHolder});
 
   runManager_->Initialize();
   physicsListHolder->initializePhysicsList();
 
   //get the pointer to the User Interface manager
   UI_ = G4UImanager::GetUIpointer();
 
   // Find the macro (or try to) along the directory path.
   std::string macroLocation = "";
   bool macroWasFound = pathFinder_.find_file(g4MacroFile_, macroLocation);
   mf::LogInfo("larg4Main") << "Finding path for " << g4MacroFile_ << "...\nSearch "
                            << (macroWasFound ? "successful " : "unsuccessful ") << "and path is: \n"
                            << macroLocation;
 
   // Execute the macro if we were able to find it
   if (macroWasFound) {
     // Create the string containing the execution command
     mf::LogInfo("larg4Main") << "Executing macro: " << g4MacroFile_;
     std::string commandToExecute = "/control/execute ";
     commandToExecute.append(macroLocation);
     UI_->ApplyCommand(commandToExecute);
   }
   else {
     mf::LogInfo("larg4Main") << "Unable to find " << g4MacroFile_ << " in the path(s) "
                              << macroPath_;
   }
 
   // Open a UI if asked
   if (uiAtBeginRun_) {
     session_ = new G4UIterminal;
     session_->SessionStart();
     delete session_;
   }
 
   // Start the Geant run!
   runManager_->BeamOnBeginRun(r.id().run());
 }

void larg4::larg4Main::endRun ( art::Run & r )

overrideprivatevirtual

Reimplemented from art::EDProducer.

Definition at line 285 of file larg4Main_module.cc.

 {
   if (--processingRun_ != 0) {
     return;
   }
 
   runManager_->BeamOnEndRun();
 }

std::vector< art::Handle< MCTruthCollection > > larg4::larg4Main::inputCollections ( art::Event const & e ) const

private

Definition at line 295 of file larg4Main_module.cc.

 {
   if (empty(inputCollectionTags_)) {
     return e.getMany<std::vector<simb::MCTruth>>();
   }
 
   std::vector<art::Handle<MCTruthCollection>> result;
   for (auto const& tag : inputCollectionTags_) {
     result.push_back(e.getHandle<MCTruthCollection>(tag));
   }
   return result;
 }

void larg4::larg4Main::produce ( art::Event & e )

overrideprivatevirtual

Implements art::EDProducer.

Definition at line 263 of file larg4Main_module.cc.

 {
   // The holder services need the event
   art::ServiceHandle<artg4tk::ActionHolderService>()->setCurrArtEvent(e);
   art::ServiceHandle<artg4tk::DetectorHolderService>()->setCurrArtEvent(e);
 
   auto const mclists = inputCollections(e);
   art::ServiceHandle<larg4::MCTruthEventActionService>()->setInputCollections(mclists);
 
   art::ServiceHandle<larg4::ParticleListActionService> pla;
   pla->setInputCollections(mclists);
   auto const pid = e.getProductID<std::vector<simb::MCParticle>>();
   pla->setPtrInfo(pid, e.productGetter(pid));
 
   runManager_->BeamOnDoOneEvent(e.id().event());
   runManager_->BeamOnEndEvent();
 
   e.put(pla->ParticleCollection());
   e.put(pla->AssnsMCTruthToMCParticle());
 }

Member Data Documentation

std::string larg4::larg4Main::afterEvent_

private

Definition at line 112 of file larg4Main_module.cc.

std::string larg4::larg4Main::g4MacroFile_

private

Definition at line 89 of file larg4Main_module.cc.

bool larg4::larg4Main::initializeDetectors_ {true}

staticprivate

Definition at line 114 of file larg4Main_module.cc.

std::vector<art::InputTag> larg4::larg4Main::inputCollectionTags_

private

Definition at line 92 of file larg4Main_module.cc.

std::string larg4::larg4Main::macroPath_

private

Definition at line 82 of file larg4Main_module.cc.

cet::search_path larg4::larg4Main::pathFinder_

private

Definition at line 86 of file larg4Main_module.cc.

bool larg4::larg4Main::pauseAfterEvent_ {false}

private

Definition at line 98 of file larg4Main_module.cc.

std::atomic< int > larg4::larg4Main::processingRun_ {0}

staticprivate

Definition at line 115 of file larg4Main_module.cc.

int larg4::larg4Main::rmvlevel_

private

Definition at line 101 of file larg4Main_module.cc.

std::unique_ptr< artg4tk::ArtG4RunManager > larg4::larg4Main::runManager_ {nullptr}

staticprivate

Definition at line 66 of file larg4Main_module.cc.

long larg4::larg4Main::seed_

private

Definition at line 76 of file larg4Main_module.cc.

G4UIsession* larg4::larg4Main::session_ {nullptr}

private

Definition at line 69 of file larg4Main_module.cc.

G4UImanager* larg4::larg4Main::UI_ {nullptr}

private

Definition at line 70 of file larg4Main_module.cc.

bool larg4::larg4Main::uiAtBeginRun_

private

Definition at line 104 of file larg4Main_module.cc.

bool larg4::larg4Main::uiAtEndEvent_ {false}

private

Definition at line 105 of file larg4Main_module.cc.

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

larg4/larg4/Core/larg4Main_module.cc

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation