art::RandomNumberGenerator Class Reference

#include "RandomNumberGenerator.h"

Classes
struct	Config
struct	ScheduleData

Public Types
enum	init_t { VIA_SEED = 1, VIA_FILE, VIA_PRODUCT }
using	base_engine_t = CLHEP::HepRandomEngine
using	seed_t = long
using	engine_state_t = RNGsnapshot::engine_state_t
using	label_t = RNGsnapshot::label_t
using	eptr_t = std::shared_ptr< base_engine_t >
using	dict_t = std::map< label_t, eptr_t >
using	tracker_t = std::map< label_t, init_t >
using	kind_t = std::map< label_t, std::string >
using	snapshot_t = std::vector< RNGsnapshot >
using	Parameters = ServiceTable< Config >

Public Member Functions
	RandomNumberGenerator (Parameters const &, art::ActivityRegistry &)
base_engine_t &	getEngine () const
base_engine_t &	getEngine (label_t const &engine_label) const

Private Member Functions
	RandomNumberGenerator (RandomNumberGenerator const &)=delete
RandomNumberGenerator &	operator= (RandomNumberGenerator const &)=delete
base_engine_t &	createEngine (ScheduleID schedule_id, seed_t seed)
base_engine_t &	createEngine (ScheduleID schedule_id, seed_t seed, std::string const &kind_of_engine_to_make)
base_engine_t &	createEngine (ScheduleID schedule_id, seed_t seed, std::string kind_of_engine_to_make, label_t const &engine_label)
base_engine_t &	getEngine (ScheduleID schedule_id, label_t const &engine_label={}) const
void	expandToNSchedules (std::size_t const n)
void	takeSnapshot_ (ScheduleID scheduleID)
void	restoreSnapshot_ (ScheduleID scheduleID, art::Event const &)
snapshot_t const &	accessSnapshot_ (ScheduleID const schedule_id) const
void	saveToFile_ ()
void	restoreFromFile_ ()
void	print_ () const
bool	invariant_holds_ (ScheduleID::size_type scheduleID)
void	preProcessEvent (art::Event const &)
void	postProcessEvent (art::Event const &)
void	postBeginJob ()
void	postEndJob ()

Private Attributes
bool	engine_creation_is_okay_ {true}
std::vector< ScheduleData >	data_
label_t const	restoreStateLabel_
std::string const	saveToFilename_
std::string const	restoreFromFilename_
unsigned const	nPrint_
bool const	debug_

Friends
class	EngineCreator
class	EventProcessor
class	RandomNumberSaver
class	test::ConcurrentEngineRetrieval

Detailed Description

Definition at line 196 of file RandomNumberGenerator.h.

Member Typedef Documentation

using art::RandomNumberGenerator::base_engine_t = CLHEP::HepRandomEngine

Definition at line 208 of file RandomNumberGenerator.h.

using art::RandomNumberGenerator::dict_t = std::map<label_t, eptr_t>

Definition at line 216 of file RandomNumberGenerator.h.

using art::RandomNumberGenerator::engine_state_t = RNGsnapshot::engine_state_t

Definition at line 210 of file RandomNumberGenerator.h.

using art::RandomNumberGenerator::eptr_t = std::shared_ptr<base_engine_t>

Definition at line 215 of file RandomNumberGenerator.h.

using art::RandomNumberGenerator::kind_t = std::map<label_t, std::string>

Definition at line 218 of file RandomNumberGenerator.h.

using art::RandomNumberGenerator::label_t = RNGsnapshot::label_t

Definition at line 214 of file RandomNumberGenerator.h.

using art::RandomNumberGenerator::Parameters = ServiceTable<Config>

Definition at line 231 of file RandomNumberGenerator.h.

using art::RandomNumberGenerator::seed_t = long

Definition at line 209 of file RandomNumberGenerator.h.

using art::RandomNumberGenerator::snapshot_t = std::vector<RNGsnapshot>

Definition at line 219 of file RandomNumberGenerator.h.

using art::RandomNumberGenerator::tracker_t = std::map<label_t, init_t>

Definition at line 217 of file RandomNumberGenerator.h.

Member Enumeration Documentation

enum art::RandomNumberGenerator::init_t

Enumerator
VIA_SEED
VIA_FILE
VIA_PRODUCT

Definition at line 213 of file RandomNumberGenerator.h.

{ VIA_SEED = 1, VIA_FILE, VIA_PRODUCT };

Constructor & Destructor Documentation

art::RandomNumberGenerator::RandomNumberGenerator ( RandomNumberGenerator const &  )

privatedelete

art::RandomNumberGenerator::RandomNumberGenerator	(	Parameters const &	,
		art::ActivityRegistry &
	)

Member Function Documentation

snapshot_t const& art::RandomNumberGenerator::accessSnapshot_ ( ScheduleID const  schedule_id ) const

inlineprivate

Definition at line 269 of file RandomNumberGenerator.h.

References art::ScheduleID::id().

Referenced by art::RandomNumberSaver::produce().

  {
    return data_[schedule_id.id()].snapshot_;
  }

base_engine_t& art::RandomNumberGenerator::createEngine ( ScheduleID  schedule_id, seed_t  seed  )

private

base_engine_t& art::RandomNumberGenerator::createEngine ( ScheduleID  schedule_id, seed_t  seed, std::string const &  kind_of_engine_to_make  )

private

base_engine_t& art::RandomNumberGenerator::createEngine ( ScheduleID  schedule_id, seed_t  seed, std::string  kind_of_engine_to_make, label_t const &  engine_label  )

private

void art::RandomNumberGenerator::expandToNSchedules ( std::size_t const  n )

inlineprivate

Definition at line 260 of file RandomNumberGenerator.h.

  {
    data_.resize(n);
  }

base_engine_t& art::RandomNumberGenerator::getEngine

(

)

const

Referenced by evgen::RadioGen::Ar42Gamma4(), evgen::RadioGen::Ar42Gamma5(), detsim::SimDriftElectrons::beginJob(), evwgh::GenieWeightCalc::Configure(), evgen::RadioGen::dirCalc(), detsim::SimWire::GenNoise(), evgen::CORSIKAGen::GetSample(), evgen::CORSIKAGen::openDBs(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), evgen::SNNueAr40CCGen::produce(), cluster::fuzzyCluster::produce(), evgen::NucleonDecay::produce(), evgen::NDKGen::produce(), cluster::HoughLineFinder::produce(), detsim::SimWire::produce(), evgen::NeutronOsc::produce(), trkf::Track3DKalman::produce(), rndm::NuRandomService::RandomNumberGeneratorSeeder(), evgen::CosmicsGen::reconfigure(), evgen::GaisserParam::Sample(), evgen::LightSource::Sample(), evgen::SingleGen::Sample(), evgen::RadioGen::samplefromth1d(), evgen::SingleGen::SampleMany(), evgen::GaisserParam::SampleOne(), evgen::RadioGen::SampleOne(), evgen::MUSUN::SampleOne(), evgen::SingleGen::SampleOne(), evgen::RadioGen::samplespectrum(), evgen::MUSUN::sampling(), evgen::NeutronOsc::SelectAnnihilationMode(), evgen::SingleGen::SelectFromHist(), and ToyOneShowerGen::ToyOneShowerGen().

base_engine_t& art::RandomNumberGenerator::getEngine

(

label_t const &

engine_label

)

const

base_engine_t& art::RandomNumberGenerator::getEngine ( ScheduleID  schedule_id, label_t const &  engine_label = {}  ) const

private

bool art::RandomNumberGenerator::invariant_holds_ ( ScheduleID::size_type  scheduleID )

private

RandomNumberGenerator& art::RandomNumberGenerator::operator= ( RandomNumberGenerator const &  )

privatedelete

void art::RandomNumberGenerator::postBeginJob ( )

private

void art::RandomNumberGenerator::postEndJob ( )

private

void art::RandomNumberGenerator::postProcessEvent ( art::Event const &  )

private

void art::RandomNumberGenerator::preProcessEvent ( art::Event const &  )

private

void art::RandomNumberGenerator::print_ ( ) const

private

Referenced by art::RandomNumberSaver::produce().

void art::RandomNumberGenerator::restoreFromFile_ ( )

private

void art::RandomNumberGenerator::restoreSnapshot_ ( ScheduleID  scheduleID, art::Event const &    )

private

void art::RandomNumberGenerator::saveToFile_ ( )

private

void art::RandomNumberGenerator::takeSnapshot_ ( ScheduleID  scheduleID )

private

Friends And Related Function Documentation

friend class EngineCreator

friend

Definition at line 197 of file RandomNumberGenerator.h.

friend class EventProcessor

friend

Definition at line 198 of file RandomNumberGenerator.h.

friend class RandomNumberSaver

friend

Definition at line 199 of file RandomNumberGenerator.h.

friend class test::ConcurrentEngineRetrieval

friend

Definition at line 200 of file RandomNumberGenerator.h.

Member Data Documentation

std::vector<ScheduleData> art::RandomNumberGenerator::data_

private

Definition at line 302 of file RandomNumberGenerator.h.

bool const art::RandomNumberGenerator::debug_

private

Definition at line 313 of file RandomNumberGenerator.h.

bool art::RandomNumberGenerator::engine_creation_is_okay_ {true}

private

Definition at line 290 of file RandomNumberGenerator.h.

unsigned const art::RandomNumberGenerator::nPrint_

private

Definition at line 312 of file RandomNumberGenerator.h.

std::string const art::RandomNumberGenerator::restoreFromFilename_

private

Definition at line 309 of file RandomNumberGenerator.h.

label_t const art::RandomNumberGenerator::restoreStateLabel_

private

Definition at line 305 of file RandomNumberGenerator.h.

std::string const art::RandomNumberGenerator::saveToFilename_

private

Definition at line 308 of file RandomNumberGenerator.h.

---

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

• art/Framework/Services/Optional/RandomNumberGenerator.h