RandomEngineStateProducer Class Reference

#include <RandomEngineStateProducer.h>

Inheritance diagram for RandomEngineStateProducer:

Public Member Functions
	RandomEngineStateProducer (edm::ParameterSet const &pset)
	~RandomEngineStateProducer () override
Public Member Functions inherited from edm::global::EDProducer< edm::BeginLuminosityBlockProducer >
	EDProducer ()=default
	EDProducer (const EDProducer &)=delete
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginProcessBlocks () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndProcessBlocks () const final
bool	hasAbilityToProduceInEndRuns () const final
EDProducer &	operator= (const EDProducer &)=delete
bool	wantsGlobalLuminosityBlocks () const final
bool	wantsGlobalRuns () const final
bool	wantsInputProcessBlocks () const final
bool	wantsProcessBlocks () const final
bool	wantsStreamLuminosityBlocks () const final
bool	wantsStreamRuns () const final
Public Member Functions inherited from edm::global::EDProducerBase
	EDProducerBase ()
ModuleDescription const &	moduleDescription () const
	~EDProducerBase () override
Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
std::vector < edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const
	ProducerBase ()
std::vector < edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...
void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
	~ProducerBase () noexcept(false) override
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase const &)=delete
	EDConsumerBase (EDConsumerBase &&)=default
ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const
std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const
std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const
ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
std::vector < ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesWhoseProductsAreConsumed (std::array< std::vector< ModuleDescription const * > *, NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
EDConsumerBase &	operator= (EDConsumerBase &&)=default
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)
Static Public Member Functions inherited from edm::global::EDProducerBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
void	globalBeginLuminosityBlockProduce (edm::LuminosityBlock &, edm::EventSetup const &) const override
void	produce (edm::StreamID iID, edm::Event &ev, edm::EventSetup const &es) const override

Additional Inherited Members
Public Types inherited from edm::global::EDProducerBase
typedef EDProducerBase	ModuleType
Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex >>
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels
Protected Member Functions inherited from edm::ProducerBase
ProducesCollector	producesCollector ()
Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)
ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...
template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
template<Transition Tr = Transition::Event>
constexpr auto	esConsumes ()
template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag)
template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
void	resetItemsToGetFrom (BranchType iType)

Detailed Description

Description: Gets the state of the random number engines from the related service and stores it in the event and luminosity block.

Implementation: This simply copies from the cache in the service and puts the product in the Event and LuminosityBlock. The cache is filled at the beginning of processing for each event or lumi by a call from the InputSource or EventProcessor to the service. This module gets called later.

Author

W. David Dagenhart, created October 4, 2006 (originally in FWCore/Services)

Definition at line 28 of file RandomEngineStateProducer.h.

Constructor & Destructor Documentation

RandomEngineStateProducer::RandomEngineStateProducer ( edm::ParameterSet const &  pset )

explicit

Definition at line 14 of file RandomEngineStateProducer.cc.

                                                                           {
  produces<edm::RandomEngineStates, edm::Transition::BeginLuminosityBlock>("beginLumi");
  produces<edm::RandomEngineStates>();
}

RandomEngineStateProducer::~RandomEngineStateProducer ( )

override

Definition at line 19 of file RandomEngineStateProducer.cc.

{}

Member Function Documentation

void RandomEngineStateProducer::fillDescriptions ( edm::ConfigurationDescriptions &  descriptions )

static

Definition at line 40 of file RandomEngineStateProducer.cc.

References edm::ConfigurationDescriptions::add(), and submitPVResolutionJobs::desc.

                                                                                           {
  edm::ParameterSetDescription desc;
  descriptions.add("randomEngineStateProducer", desc);
}

void RandomEngineStateProducer::globalBeginLuminosityBlockProduce ( edm::LuminosityBlock &  lb, edm::EventSetup const &    ) const

overrideprivate

Definition at line 30 of file RandomEngineStateProducer.cc.

References edm::RandomNumberGenerator::getLumiCache(), edm::LuminosityBlock::index(), edm::Service< T >::isAvailable(), eostools::move(), and edm::LuminosityBlock::put().

                                                                                              {
  edm::Service<edm::RandomNumberGenerator> randomService;
  if (randomService.isAvailable()) {
    auto states = std::make_unique<edm::RandomEngineStates>();
    states->setRandomEngineStates(randomService->getLumiCache(lb.index()));
    lb.put(std::move(states), "beginLumi");
  }
}

void RandomEngineStateProducer::produce ( edm::StreamID  iID, edm::Event &  ev, edm::EventSetup const &  es  ) const

overrideprivatevirtual

Implements edm::global::EDProducerBase.

Definition at line 21 of file RandomEngineStateProducer.cc.

References edm::RandomNumberGenerator::getEventCache(), edm::Service< T >::isAvailable(), eostools::move(), edm::Event::put(), and edm::Event::streamID().

                                                                                                 {
  edm::Service<edm::RandomNumberGenerator> randomService;
  if (randomService.isAvailable()) {
    auto states = std::make_unique<edm::RandomEngineStates>();
    states->setRandomEngineStates(randomService->getEventCache(ev.streamID()));
    ev.put(std::move(states));
  }
}