CMS 3D CMS Logo

List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions
RandomEngineStateProducer Class Reference

#include <RandomEngineStateProducer.h>

Inheritance diagram for RandomEngineStateProducer:
edm::global::EDProducer< edm::BeginLuminosityBlockProducer > edm::global::EDProducerBase edm::ProducerBase edm::EDConsumerBase edm::ProductRegistryHelper

Public Member Functions

 RandomEngineStateProducer (edm::ParameterSet const &pset)
 
 ~RandomEngineStateProducer () override
 
- Public Member Functions inherited from edm::global::EDProducer< edm::BeginLuminosityBlockProducer >
 EDProducer ()=default
 
bool hasAbilityToProduceInBeginLumis () const final
 
bool hasAbilityToProduceInBeginRuns () const final
 
bool hasAbilityToProduceInEndLumis () const final
 
bool hasAbilityToProduceInEndRuns () const final
 
bool wantsGlobalLuminosityBlocks () const final
 
bool wantsGlobalRuns () 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< ConsumesInfoconsumesInfo () 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
 
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::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
 
EDConsumerBase const & operator= (EDConsumerBase const &)=delete
 
EDConsumerBaseoperator= (EDConsumerBase &&)=default
 
bool registeredToConsume (ProductResolverIndex, bool, BranchType) const
 
bool registeredToConsumeMany (TypeID const &, BranchType) const
 
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)
 
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<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)
 

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.

14  {
15  produces<edm::RandomEngineStates, edm::Transition::BeginLuminosityBlock>("beginLumi");
16  produces<edm::RandomEngineStates>();
17 }
RandomEngineStateProducer::~RandomEngineStateProducer ( )
override

Definition at line 19 of file RandomEngineStateProducer.cc.

19 {}

Member Function Documentation

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

Definition at line 40 of file RandomEngineStateProducer.cc.

References edm::ConfigurationDescriptions::add().

40  {
42  descriptions.add("randomEngineStateProducer", desc);
43 }
void add(std::string const &label, ParameterSetDescription const &psetDescription)
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().

31  {
33  if (randomService.isAvailable()) {
34  auto states = std::make_unique<edm::RandomEngineStates>();
35  states->setRandomEngineStates(randomService->getLumiCache(lb.index()));
36  lb.put(std::move(states), "beginLumi");
37  }
38 }
LuminosityBlockIndex index() const
virtual std::vector< RandomEngineState > const & getLumiCache(LuminosityBlockIndex const &) const =0
void put(std::unique_ptr< PROD > product)
Put a new product.
bool isAvailable() const
Definition: Service.h:40
def move(src, dest)
Definition: eostools.py:511
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().

21  {
23  if (randomService.isAvailable()) {
24  auto states = std::make_unique<edm::RandomEngineStates>();
25  states->setRandomEngineStates(randomService->getEventCache(ev.streamID()));
26  ev.put(std::move(states));
27  }
28 }
OrphanHandle< PROD > put(std::unique_ptr< PROD > product)
Put a new product.
Definition: Event.h:131
bool isAvailable() const
Definition: Service.h:40
virtual std::vector< RandomEngineState > const & getEventCache(StreamID const &) const =0
StreamID streamID() const
Definition: Event.h:96
def move(src, dest)
Definition: eostools.py:511