#include "LegacyModule.h"

Inheritance diagram for art::detail::LegacyModule:

Classes
class	ScheduleIDSentry

Public Types
using	base_engine_t = EngineCreator::base_engine_t

using	seed_t = EngineCreator::seed_t

using	label_t = EngineCreator::label_t

Public Member Functions
	LegacyModule (std::string const &module_label)

ScheduleID	scheduleID () const noexcept

hep::concurrency::SerialTaskQueueChain *	serialTaskQueueChain () const

std::set< std::string > const &	sharedResources () const

void	createQueues (SharedResources const &resources)

template<BranchType , typename... T>
void	serialize (T const &...resources)

template<BranchType , typename... T>
void	serializeExternal (T const &...resources)

Protected Member Functions
template<BranchType BT = InEvent, typename... T>
void	serialize (T const &...)

template<BranchType BT = InEvent, typename... T>
void	serializeExternal (T const &...)

template<BranchType BT = InEvent>
void	async ()

Private Types
using	engine_state_t = RNGsnapshot::engine_state_t

Private Member Functions
void	setScheduleID (ScheduleID const sid) noexcept

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 Attributes
std::atomic< ScheduleID >	scheduleID_

Detailed Description

Definition at line 13 of file LegacyModule.h.

Member Typedef Documentation

using art::detail::LegacyModule::base_engine_t = EngineCreator::base_engine_t

Definition at line 19 of file LegacyModule.h.

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

inherited

Definition at line 39 of file EngineCreator.h.

using art::detail::LegacyModule::label_t = EngineCreator::label_t

Definition at line 21 of file LegacyModule.h.

using art::detail::LegacyModule::seed_t = EngineCreator::seed_t

Definition at line 20 of file LegacyModule.h.

Constructor & Destructor Documentation

art::detail::LegacyModule::LegacyModule ( std::string const & module_label )

explicit

Definition at line 5 of file LegacyModule.cc.

References art::ScheduleID::first(), art::detail::LegacyResource, and art::detail::SharedModule::serialize().

     : EngineCreator{module_label, ScheduleID::first()}
   {
     serialize(detail::LegacyResource);
   }

Member Function Documentation

template<BranchType BT = InEvent>

void art::detail::SharedModule::async ( )

inlineprotectedinherited

Definition at line 38 of file SharedModule.h.

References art::detail::SharedModule::asyncDeclared_, art::detail::SharedModule::implicit_serialize(), art::InEvent, and art::detail::SharedModule::serialize_for().

     {
       static_assert(
         BT == InEvent,
         "async is currently supported only for the 'InEvent' level.");
       asyncDeclared_ = true;
     }

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t seed )

inherited

Definition at line 20 of file EngineCreator.cc.

References art::detail::EngineCreator::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
	)

inherited

Definition at line 26 of file EngineCreator.cc.

References art::detail::EngineCreator::moduleLabel_, art::detail::EngineCreator::requireValid(), art::detail::EngineCreator::rng(), and art::detail::EngineCreator::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
	)

inherited

Definition at line 34 of file EngineCreator.cc.

References art::detail::EngineCreator::moduleLabel_, art::detail::EngineCreator::requireValid(), art::detail::EngineCreator::rng(), and art::detail::EngineCreator::sid_.

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

void art::detail::SharedModule::createQueues ( SharedResources const & resources )

inherited

Definition at line 34 of file SharedModule.cc.

References art::detail::SharedModule::asyncDeclared_, util::cbegin(), util::cend(), art::detail::SharedModule::chain_, art::detail::SharedResources::createQueues(), e, util::empty(), art::errors::LogicError, and art::detail::SharedModule::resourceNames_.

Referenced by art::OutputModule::doBeginJob(), art::SharedFilter::setupQueues(), art::SharedProducer::setupQueues(), art::SharedAnalyzer::setupQueues(), art::EDFilter::setupQueues(), art::EDProducer::setupQueues(), and art::EDAnalyzer::setupQueues().

   {
     Exception e{errors::LogicError,
                 "An error occurred while processing scheduling options for a "
                 "module.\n"};
     if (asyncDeclared_) {
       if (empty(resourceNames_)) {
         return;
       }
       throw e
         << "async<art::InEvent>() cannot be called in combination with any "
            "serialize<art::InEvent>(...) calls.\n";
     }
 
     if (empty(resourceNames_)) {
       throw e << "Either 'async<art::InEvent>()' or "
                  "'serialize<art::InEvent>(...)'\n"
                  "must be called in a shared module's constructor.\n";
     }
     std::vector<std::string> const names(cbegin(resourceNames_),
                                          cend(resourceNames_));
     auto queues = resources.createQueues(names);
     chain_ = std::make_unique<SerialTaskQueueChain>(queues);
   }

ScheduleID art::detail::LegacyModule::scheduleID ( ) const

noexcept

Definition at line 12 of file LegacyModule.cc.

References scheduleID_.

Referenced by art::EDAnalyzer::EDAnalyzer(), art::EDFilter::EDFilter(), and art::EDProducer::EDProducer().

   {
     return scheduleID_.load();
   }

template<BranchType BT = InEvent, typename... T>

void art::detail::SharedModule::serialize ( T const & ... )

protectedinherited

Referenced by simfilter::FilterSimPhotonLiteTime::FilterSimPhotonLiteTime(), simfilter::FilterSimPhotonTime::FilterSimPhotonTime(), LegacyModule(), and art::OutputModule::OutputModule().

template<BranchType , typename... T>

void art::detail::SharedModule::serialize ( T const &... resources )

inherited

Definition at line 83 of file SharedModule.h.

References art::detail::SharedModule::serialize_for_resource().

   {
     serialize_for_resource(resources...);
   }

template<BranchType BT = InEvent, typename... T>

void art::detail::SharedModule::serializeExternal ( T const & ... )

protectedinherited

Referenced by wcls::WireCellToolkit::WireCellToolkit().

template<BranchType , typename... T>

void art::detail::SharedModule::serializeExternal ( T const &... resources )

inherited

Definition at line 90 of file SharedModule.h.

References art::detail::SharedModule::serialize_for_external_resource().

   {
     serialize_for_external_resource(resources...);
   }

SerialTaskQueueChain * art::detail::SharedModule::serialTaskQueueChain ( ) const

inherited

Definition at line 22 of file SharedModule.cc.

References art::detail::SharedModule::chain_.

   {
     return chain_.get();
   }

void art::detail::LegacyModule::setScheduleID ( ScheduleID const sid )

privatenoexcept

Definition at line 18 of file LegacyModule.cc.

References scheduleID_.

   {
     scheduleID_ = sid;
   }

std::set< std::string > const & art::detail::SharedModule::sharedResources ( ) const

inherited

Definition at line 28 of file SharedModule.cc.

References art::detail::SharedModule::resourceNames_.

   {
     return resourceNames_;
   }

Member Data Documentation

std::atomic<ScheduleID> art::detail::LegacyModule::scheduleID_

private

Definition at line 32 of file LegacyModule.h.

Referenced by scheduleID(), and setScheduleID().

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

art/Framework/Core/detail/LegacyModule.h
art/Framework/Core/detail/LegacyModule.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation