art::detail::EngineCreator Class Reference

#include "EngineCreator.h"

Inheritance diagram for art::detail::EngineCreator:

Public Types
using	base_engine_t = CLHEP::HepRandomEngine
using	label_t = RNGsnapshot::label_t
using	seed_t = long
using	engine_state_t = RNGsnapshot::engine_state_t

Public Member Functions
	EngineCreator (std::string const &label, ScheduleID sid)
base_engine_t &	createEngine (seed_t seed)
base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)
base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)

Private Types
using	RNGservice = RandomNumberGenerator

Private Member Functions
void	requireValid ()

Static Private Member Functions
static ServiceHandle< RandomNumberGenerator > &	rng ()

Private Attributes
std::string const	moduleLabel_ {}
ScheduleID const	sid_ {}

Detailed Description

Definition at line 31 of file EngineCreator.h.

Member Typedef Documentation

using art::detail::EngineCreator::base_engine_t = CLHEP::HepRandomEngine

Definition at line 36 of file EngineCreator.h.

using art::detail::EngineCreator::engine_state_t = RNGsnapshot::engine_state_t

Definition at line 39 of file EngineCreator.h.

using art::detail::EngineCreator::label_t = RNGsnapshot::label_t

Definition at line 37 of file EngineCreator.h.

using art::detail::EngineCreator::RNGservice = RandomNumberGenerator

private

Definition at line 32 of file EngineCreator.h.

using art::detail::EngineCreator::seed_t = long

Definition at line 38 of file EngineCreator.h.

Constructor & Destructor Documentation

EngineCreator::EngineCreator ( std::string const &  label, ScheduleID  sid  )

explicit

Definition at line 14 of file EngineCreator.cc.

References sid_.

  : moduleLabel_{moduleLabel}, sid_{sid}
{}

Member Function Documentation

EngineCreator::base_engine_t & EngineCreator::createEngine

(

seed_t

seed

)

Definition at line 20 of file EngineCreator.cc.

References rng().

Referenced by evg::AddGenieEventsToArt::AddGenieEventsToArt(), artg4tk::artg4tkMain::artg4tkMain(), evgen::BaseRadioGen::BaseRadioGen(), evgen::CORSIKAGen::CORSIKAGen(), evgen::CosmicsGen::CosmicsGen(), art::MixHelper::createEngine(), detsim::DriftElectronstoPlane::DriftElectronstoPlane(), art::EDAnalyzer::EDAnalyzer(), art::EDFilter::EDFilter(), art::EDProducer::EDProducer(), artg4tk::EventGenerator::EventGenerator(), evwgh::EventWeight::EventWeight(), evgen::GaisserParam::GaisserParam(), cluster::HoughLineFinder::HoughLineFinder(), art::MixHelper::initEngine_(), larg4::IonAndScint::IonAndScint(), larg4::ISCalcAna::ISCalcAna(), larg4::LArG4::LArG4(), larg4::larg4Main::larg4Main(), evgen::larg4SingleGen::larg4SingleGen(), evgen::LightSource::LightSource(), evgen::MUSUN::MUSUN(), evgen::NDKGen::NDKGen(), evgen::NeutronOsc::NeutronOsc(), nnet::NoiseWaveformDump::NoiseWaveformDump(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PDFastSimANN::PDFastSimANN(), phot::PDFastSimPAR::PDFastSimPAR(), phot::PDFastSimPVS::PDFastSimPVS(), evgen::PhotonGen::PhotonGen(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), evgen::RadioGen::RadioGen(), nnet::RawWaveformClnSigDump::RawWaveformClnSigDump(), nnet::RawWaveformDump::RawWaveformDump(), art::ReplicatedAnalyzer::ReplicatedAnalyzer(), art::ReplicatedFilter::ReplicatedFilter(), art::ReplicatedProducer::ReplicatedProducer(), detsim::SimDriftElectrons::SimDriftElectrons(), detsim::SimWire::SimWire(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), and trkf::Track3DKalman::Track3DKalman().

{
  return createEngine(seed, rng()->defaultEngineKind());
}

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make
	)

Definition at line 26 of file EngineCreator.cc.

References moduleLabel_, requireValid(), rng(), and sid_.

{
  requireValid();
  return rng()->createEngine(sid_, moduleLabel_, seed, kind_of_engine_to_make);
}

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make,
		label_t const &	engine_label
	)

Definition at line 34 of file EngineCreator.cc.

References moduleLabel_, requireValid(), rng(), and sid_.

{
  requireValid();
  return rng()->createEngine(
    sid_, moduleLabel_, seed, kind_of_engine_to_make, engine_label);
}

void EngineCreator::requireValid ( )

private

Definition at line 51 of file EngineCreator.cc.

References art::ScheduleID::isValid(), art::errors::LogicError, moduleLabel_, and sid_.

Referenced by createEngine().

{
  if (sid_.isValid() && !moduleLabel_.empty()) {
    return;
  }
  throw Exception{
    errors::LogicError,
    "An error occurred while creating a random-number engine.\n\n"}
    << "No module label or schedule ID available to create engine.\n"
    << "Please ensure that your module calls the correct base-class\n"
       "constructor.  The module class and module label can be determined\n"
       "by looking for the '<module class>:<module label>@Construction' "
       "string\n"
       "in the message context a few lines above.  For example, if your\n"
       "module is a filter with class name 'MyFilter' please make the\n"
       "following change to your constructor:\n\n"
    << "  Wrong:  MyFilter(ParameterSet const& ps) :\n"
    << "            dataMembers_, ...\n"
    << "          {}\n\n"
    << "  Right:  MyFilter(ParameterSet const& ps) :\n"
    << "            " << cet::bold_fontify("art::EDFilter{ps},")
    << " dataMembers_, ...\n"
    << "          {}\n\n"
    << "If your module is a producer, 'art::EDFilter{ps}' above should be\n"
       "replaced with 'art::EDProducer{ps}.\n";
}

art::ServiceHandle< art::RandomNumberGenerator > & EngineCreator::rng ( void  )

staticprivate

Definition at line 44 of file EngineCreator.cc.

Referenced by createEngine(), and evgen::PhotonGen::produce().

{
  static art::ServiceHandle<art::RandomNumberGenerator> rng;
  return rng;
}

Member Data Documentation

std::string const art::detail::EngineCreator::moduleLabel_ {}

private

Definition at line 53 of file EngineCreator.h.

Referenced by createEngine(), and requireValid().

ScheduleID const art::detail::EngineCreator::sid_ {}

private

Definition at line 54 of file EngineCreator.h.

Referenced by createEngine(), EngineCreator(), and requireValid().

---

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

• art/Framework/Core/detail/EngineCreator.h
• art/Framework/Core/detail/EngineCreator.cc