Test module for random engine managing interface of NuRandomService. More...

Inheritance diagram for testing::RandomManagerTest:

Public Types
typedef art::detail::EngineCreator::seed_t	seed_t

Public Types inherited from art::EDAnalyzer
using	WorkerType = WorkerT< EDAnalyzer >

using	ModuleType = EDAnalyzer

Public Member Functions
	RandomManagerTest (fhicl::ParameterSet const &pset)

void	analyze (const art::Event &event) override

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

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

std::string	workerType () const

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

	Analyzer (fhicl::ParameterSet const &pset)

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

void	doBeginJob ()

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::Observer
	~Observer () noexcept

	Observer (Observer const &)=delete

	Observer (Observer &&)=delete

Observer &	operator= (Observer const &)=delete

Observer &	operator= (Observer &&)=delete

void	registerProducts (ProductDescriptions &, ModuleDescription const &)

void	fillDescriptions (ModuleDescription const &)

std::string const &	processName () const

bool	wantAllEvents () const

bool	wantEvent (Event const &e)

fhicl::ParameterSetID	selectorConfig () const

Handle< TriggerResults >	getTriggerResults (Event const &e) const

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 Attributes
std::string	moduleLabel

std::map< std::string, cet::exempt_ptr< CLHEP::HepRandomEngine > >	engines

std::unique_ptr< CLHEP::HepRandomEngine >	extEngine {nullptr}

cet::exempt_ptr< CLHEP::HepRandomEngine >	stdEngine {nullptr}

Additional Inherited Members
Protected Member Functions inherited from art::Observer
	Observer (fhicl::ParameterSet const &config)

	Observer (std::vector< std::string > const &paths, fhicl::ParameterSet const &config)

detail::ProcessAndEventSelectors &	processAndEventSelectors ()

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

Test module for random engine managing interface of NuRandomService.

The test writes on screen the random seeds it gets.

Configuration parameters:

instanceNames (string list, optional): use one random number generator for each instance name here specified; if not specified, an anonymous engine is used
externalInstance (string, optional): if specified, an engine not managed by RandomNumberGenerator is also used, with this instance name
standardInstance (string, optional): if specified, an engine is created by RandomNumberGenerator but not registered is NuRandomService is also used, with this instance name
Seed, Seed_XXX (strings, optional): set the seed of instance XXX to a set value ("Seed" sets the seed of the anonymous instance)

Definition at line 63 of file RandomManagerTest_module.cc.

Member Typedef Documentation

typedef art::detail::EngineCreator::seed_t testing::RandomManagerTest::seed_t

Definition at line 65 of file RandomManagerTest_module.cc.

Constructor & Destructor Documentation

testing::RandomManagerTest::RandomManagerTest ( fhicl::ParameterSet const & pset )

explicit

Definition at line 84 of file RandomManagerTest_module.cc.

                                                                    :
     art::EDAnalyzer{pset},
     moduleLabel{pset.get<std::string>("module_label")}
   {
     art::ServiceHandle<rndm::NuRandomService> EngineManager;
 
     // check if we want an "external" engine
     std::string externalInstanceName{};
     if (pset.get_if_present("externalInstance", externalInstanceName)) {
       mf::LogInfo("RandomManagerTest") << "Creating an unmanaged engine '"
         << externalInstanceName << "' in module '" << moduleLabel << "'";
       extEngine = std::make_unique<CLHEP::Ranlux64Engine>();
 
       EngineManager->registerEngine(
         [this](rndm::NuRandomService::EngineId const&, seed_t seed)
           { this->extEngine->setSeed(seed, 0); },
         externalInstanceName, pset, "Seed_" + externalInstanceName
         );
     } // if we have the external engine
 
     // check if we want an unmanaged standard engine
     std::string standardInstanceName{};
     if (pset.get_if_present("standardInstance", standardInstanceName)) {
       mf::LogInfo("RandomManagerTest") << "Creating a standard engine '"
         << standardInstanceName << "' in module '" << moduleLabel
         << "' with RandomNumberGenerator";
       seed_t seed
         = pset.get<unsigned int>("Seed_" + standardInstanceName, 0);
       stdEngine = &createEngine(seed, "HepJamesRandom", standardInstanceName);
     } // if we have the external engine
 
     // initialize the standard engines with RandomNumberGenerator
     auto const instanceNames = pset.get<std::vector<std::string>>("instanceNames", {});
       for (std::string const& instanceName: instanceNames) {
         mf::LogInfo("RandomManagerTest") << "Creating a default engine '"
                                        << instanceName << "' in module '" << moduleLabel << "'";
         CLHEP::HepRandomEngine& engine = EngineManager->createEngine
           (*this, "HepJamesRandom", instanceName, pset, "Seed_" + instanceName);
       engines.emplace(instanceName, &engine);
     }
 
     // create a default engine, if needed
     if (instanceNames.empty() && !extEngine && !stdEngine) {
       mf::LogInfo("RandomManagerTest")
         << "Creating a nameless default engine in module '"
         << moduleLabel << "'";
       CLHEP::HepRandomEngine& engine = EngineManager->createEngine(*this, pset, "Seed");
       engines.emplace("", &engine);
     }
 
     { // anonymous block
       mf::LogInfo log("RandomManagerTest");
       log << "RandomManagerTest[" << moduleLabel << "]: instances:";
       for (std::string const& instanceName: instanceNames)
         log << " " << instanceName;
     } // anonymous block
 
     // Add non-art-managed engines to list of engines
     if (extEngine) {
       assert(!externalInstanceName.empty());
       engines.emplace(externalInstanceName, extEngine.get());
     }
 
     if (stdEngine) {
       assert(!standardInstanceName.empty());
       engines.emplace(standardInstanceName, stdEngine);
     }
 
   } // RandomManagerTest::RandomManagerTest()

Member Function Documentation

void testing::RandomManagerTest::analyze ( const art::Event & event )

override

Definition at line 156 of file RandomManagerTest_module.cc.

   {
     mf::LogVerbatim("RandomManagerTest") << "RandomManagerTest[" << moduleLabel << "]::analyze "
                                          << event.id();
 
     for (auto& [instanceName, engine] : engines) {
       seed_t actualSeed = testing::NuRandomService::readSeed(*engine);
       mf::LogVerbatim("RandomManagerTest")
         << std::setw(12) << (instanceName.empty()? "<default>": instanceName)
         << ": " << testing::NuRandomService::CreateCharacter(*engine)
         << "   (seed: " << actualSeed << ")";
     }
   } // RandomManagerTest::analyze()