CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
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::one::EDProducer< edm::BeginLuminosityBlockProducer > edm::one::EDProducerBase edm::ProducerBase edm::EDConsumerBase edm::ProductRegistryHelper

Public Member Functions

 RandomEngineStateProducer (edm::ParameterSet const &pset)
 
 ~RandomEngineStateProducer ()
 
- Public Member Functions inherited from edm::one::EDProducer< edm::BeginLuminosityBlockProducer >
 EDProducer ()=default
 
- Public Member Functions inherited from edm::one::EDProducerBase
 EDProducerBase ()
 
ModuleDescription const & moduleDescription () const
 
virtual ~EDProducerBase ()
 
- Public Member Functions inherited from edm::ProducerBase
 ProducerBase ()
 
void registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
 
std::function< void(BranchDescription
const &)> 
registrationCallback () const
 used by the fwk to register list of products More...
 
virtual ~ProducerBase ()
 
- Public Member Functions inherited from edm::EDConsumerBase
 EDConsumerBase ()
 
ProductHolderIndexAndSkipBit indexFrom (EDGetToken, BranchType, TypeID const &) const
 
void itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
 
void itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
 
std::vector
< ProductHolderIndexAndSkipBit >
const & 
itemsToGetFromEvent () const
 
void labelsForToken (EDGetToken iToken, Labels &oLabels) const
 
bool registeredToConsume (ProductHolderIndex, bool, BranchType) const
 
bool registeredToConsumeMany (TypeID const &, BranchType) const
 
void updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
 
virtual ~EDConsumerBase ()
 

Static Public Member Functions

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

Private Member Functions

virtual void beginLuminosityBlockProduce (edm::LuminosityBlock &lb, edm::EventSetup const &es) override
 
virtual void produce (edm::Event &ev, edm::EventSetup const &es) override
 

Additional Inherited Members

- Public Types inherited from edm::one::EDProducerBase
typedef EDProducerBase ModuleType
 
- Public Types inherited from edm::ProducerBase
typedef
ProductRegistryHelper::TypeLabelList 
TypeLabelList
 
- Protected Member Functions inherited from edm::ProducerBase
void callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
 
- 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 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.

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 eac event or lumi by a call from the InputSource 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::InLumi>("beginLumi");
16  produces<edm::RandomEngineStates>();
17 }
RandomEngineStateProducer::~RandomEngineStateProducer ( )

Definition at line 19 of file RandomEngineStateProducer.cc.

19  {
20 }

Member Function Documentation

void RandomEngineStateProducer::beginLuminosityBlockProduce ( edm::LuminosityBlock lb,
edm::EventSetup const &  es 
)
overrideprivatevirtual

Definition at line 33 of file RandomEngineStateProducer.cc.

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

33  {
35  if(randomService.isAvailable()) {
36  std::auto_ptr<edm::RandomEngineStates> states(new edm::RandomEngineStates);
37  states->setRandomEngineStates(randomService->getLumiCache());
38  lb.put(states, "beginLumi");
39  }
40 }
virtual std::vector< RandomEngineState > const & getLumiCache() const =0
bool isAvailable() const
Definition: Service.h:46
void put(std::auto_ptr< PROD > product)
Put a new product.
void RandomEngineStateProducer::fillDescriptions ( edm::ConfigurationDescriptions descriptions)
static

Definition at line 43 of file RandomEngineStateProducer.cc.

References edm::ConfigurationDescriptions::add().

43  {
45  descriptions.add("randomEngineStateProducer", desc);
46 }
void add(std::string const &label, ParameterSetDescription const &psetDescription)
void RandomEngineStateProducer::produce ( edm::Event ev,
edm::EventSetup const &  es 
)
overrideprivatevirtual

Implements edm::one::EDProducerBase.

Definition at line 23 of file RandomEngineStateProducer.cc.

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

23  {
25  if(randomService.isAvailable()) {
26  std::auto_ptr<edm::RandomEngineStates> states(new edm::RandomEngineStates);
27  states->setRandomEngineStates(randomService->getEventCache());
28  ev.put(states);
29  }
30 }
OrphanHandle< PROD > put(std::auto_ptr< PROD > product)
Put a new product.
Definition: Event.h:116
bool isAvailable() const
Definition: Service.h:46
virtual std::vector< RandomEngineState > const & getEventCache() const =0