#include <ESProducer.h>

Inheritance diagram for edm::ESProducer:

Public Member Functions
	ESProducer ()

	ESProducer (const ESProducer &)=delete

ESProxyIndex const *	getTokenIndices (unsigned int iIndex) const

ESRecordIndex const *	getTokenRecordIndices (unsigned int iIndex) const

bool	hasMayConsumes () const noexcept

size_t	numberOfTokenIndices (unsigned int iIndex) const

ESProducer const &	operator= (const ESProducer &)=delete

SerialTaskQueueChain &	queue ()

template<typename Record >
std::optional< std::vector < ESProxyIndex > >	updateFromMayConsumes (unsigned int iIndex, const Record &iRecord) const

void	updateLookup (eventsetup::ESRecordsToProxyIndices const &) final

	~ESProducer () noexcept(false) override

Public Member Functions inherited from edm::ESProxyFactoryProducer
	ESProxyFactoryProducer ()

	ESProxyFactoryProducer (const ESProxyFactoryProducer &)=delete

const ESProxyFactoryProducer &	operator= (const ESProxyFactoryProducer &)=delete

	~ESProxyFactoryProducer () noexcept(false) override

Public Member Functions inherited from edm::eventsetup::DataProxyProvider
void	createKeyedProxies (EventSetupRecordKey const &key, unsigned int nConcurrentIOVs)

	DataProxyProvider ()

	DataProxyProvider (const DataProxyProvider &)=delete

const ComponentDescription &	description () const

void	fillRecordsNotAllowingConcurrentIOVs (std::set< EventSetupRecordKey > &recordsNotAllowingConcurrentIOVs) const

virtual void	initConcurrentIOVs (EventSetupRecordKey const &key, unsigned int nConcurrentIOVs)

bool	isUsingRecord (const EventSetupRecordKey &key) const

KeyedProxies &	keyedProxies (const EventSetupRecordKey &iRecordKey, unsigned int iovIndex=0)

const DataProxyProvider &	operator= (const DataProxyProvider &)=delete

void	setAppendToDataLabel (const edm::ParameterSet &)

void	setDescription (const ComponentDescription &iDescription)

std::set< EventSetupRecordKey >	usingRecords () const

virtual	~DataProxyProvider () noexcept(false)

Protected Member Functions
template<typename T >
auto	setWhatProduced (T *iThis, const es::Label &iLabel={})

template<typename T >
auto	setWhatProduced (T iThis, const char iLabel)

template<typename T >
auto	setWhatProduced (T *iThis, const std::string &iLabel)

template<typename T , typename TDecorator >
auto	setWhatProduced (T *iThis, const TDecorator &iDec, const es::Label &iLabel={})

template<typename T , typename TReturn , typename TRecord >
auto	setWhatProduced (T iThis, TReturn(T::iMethod)(const TRecord &), const es::Label &iLabel={})

template<typename T , typename TReturn , typename TRecord , typename TArg >
ESConsumesCollectorT< TRecord >	setWhatProduced (T iThis, TReturn(T::iMethod)(const TRecord &), const TArg &iDec, const es::Label &iLabel={})

void	usesResources (std::vector< std::string > const &)

Protected Member Functions inherited from edm::ESProxyFactoryProducer
template<class TFactory >
void	registerFactory (std::unique_ptr< TFactory > iFactory, const std::string &iLabel=std::string())

virtual void	registerFactoryWithKey (const EventSetupRecordKey &iRecord, std::unique_ptr< eventsetup::ProxyFactoryBase > iFactory, const std::string &iLabel=std::string())

KeyedProxiesVector	registerProxies (const EventSetupRecordKey &, unsigned int iovIndex) override

Protected Member Functions inherited from edm::eventsetup::DataProxyProvider
template<class T >
void	usingRecord ()

void	usingRecordWithKey (const EventSetupRecordKey &key)

Private Member Functions
template<typename CallbackT , typename TProduct , typename TRecord >
void	registerProduct (std::shared_ptr< std::pair< unsigned int, std::shared_ptr< CallbackT >>> iCallback, const TProduct , const TRecord , const es::Label &iLabel)

template<typename CallbackT , typename TProduct , typename TRecord , int IIndex>
void	registerProduct (std::shared_ptr< std::pair< unsigned int, std::shared_ptr< CallbackT >>> iCallback, const es::L< TProduct, IIndex > , const TRecord , const es::Label &iLabel)

template<typename CallbackT , typename TList , typename TRecord >
void	registerProducts (std::shared_ptr< std::pair< unsigned int, std::shared_ptr< CallbackT >>> iCallback, const TList , const TRecord iRecord, const es::Label &iLabel)

template<typename CallbackT , typename TRecord >
void	registerProducts (std::shared_ptr< std::pair< unsigned int, std::shared_ptr< CallbackT >>>, const eventsetup::produce::Null , const TRecord , const es::Label &)

Private Attributes
SharedResourcesAcquirer	acquirer_

std::vector< std::unique_ptr < ESConsumesInfo > >	consumesInfos_

bool	hasMayConsumes_ = false

std::vector< std::vector < ESProxyIndex > >	itemsToGetFromRecords_

std::vector< std::vector < ESRecordIndex > >	recordsUsedDuringGet_

std::unique_ptr< std::vector < std::string > >	sharedResourceNames_

Additional Inherited Members
Static Public Member Functions inherited from edm::eventsetup::DataProxyProvider
static void	prevalidate (ConfigurationDescriptions &)

Protected Types inherited from edm::ESProxyFactoryProducer
using	EventSetupRecordKey = eventsetup::EventSetupRecordKey

Protected Types inherited from edm::eventsetup::DataProxyProvider
using	KeyedProxiesVector = std::vector< std::pair< DataKey, std::shared_ptr< DataProxy >>>

Detailed Description

Description: An EventSetup algorithmic Provider that encapsulates the algorithm as a member method

Usage: Inheriting from this class is the simplest way to create an algorithm which gets called when a new data item is needed for the EventSetup. This class is designed to call a member method of inheriting classes each time the algorithm needs to be run. (A more flexible system in which the algorithms can be set at run-time instead of compile time can be obtained by inheriting from ESProxyFactoryProducer instead.)

If only one algorithm is being encapsulated then the user needs to 1) add a method name 'produce' to the class. The 'produce' takes as its argument a const reference to the record that is to hold the data item being produced. If only one data item is being produced, the 'produce' method must return either an 'std::unique_ptr' or 'std::shared_ptr' to the object being produced. (The choice depends on if the EventSetup or the ESProducer is managing the lifetime of the object). If multiple items are being Produced they the 'produce' method must return an ESProducts<> object which holds all of the items. 2) add 'setWhatProduced(this);' to their classes constructor

Example: one algorithm creating only one object

class FooProd : public edm::ESProducer {
   std::unique_ptr<Foo> produce(const FooRecord&);
   ...
};
FooProd::FooProd(const edm::ParameterSet&) {
   setWhatProduced(this);
   ...
}

Example: one algorithm creating two objects

class FoosProd : public edm::ESProducer {
   edm::ESProducts<std::unique_ptr<Foo1>, std::unique_ptr<Foo2>> produce(const FooRecord&);
   ...
};

If multiple algorithms are being encapsulated then 1) like 1 above except the methods can have any names you want 2) add 'setWhatProduced(this, &<class name>::<method name>);' for each method in the class' constructor NOTE: the algorithms can put data into the same record or into different records

Example: two algorithms each creating only one objects

class FooBarProd : public edm::eventsetup::ESProducer {
   std::unique_ptr<Foo> produceFoo(const FooRecord&);
   std::unique_ptr<Bar> produceBar(const BarRecord&);
   ...
};
FooBarProd::FooBarProd(const edm::ParameterSet&) {
   setWhatProduced(this,&FooBarProd::produceFoo);
   setWhatProduced(this,&FooBarProd::produceBar);
   ...
}

Definition at line 104 of file ESProducer.h.

Constructor & Destructor Documentation

edm::ESProducer::ESProducer ( )

Definition at line 30 of file ESProducer.cc.

30 : consumesInfos_{}, acquirer_{{{std::make_shared<SerialTaskQueue>()}}} {}

edm::ESProducer::consumesInfos_

std::vector< std::unique_ptr< ESConsumesInfo > > consumesInfos_

Definition: ESProducer.h:260

edm::ESProducer::acquirer_

SharedResourcesAcquirer acquirer_

Definition: ESProducer.h:266

edm::ESProducer::~ESProducer ( )

overridenoexcept

edm::ESProducer::ESProducer ( const ESProducer & )

delete

Member Function Documentation

ESProxyIndex const* edm::ESProducer::getTokenIndices ( unsigned int iIndex ) const

inline

Definition at line 112 of file ESProducer.h.

References relativeConstraints::empty, and itemsToGetFromRecords_.

                                                                    {
       if (itemsToGetFromRecords_.empty()) {
         return nullptr;
       }
       return (itemsToGetFromRecords_[iIndex].empty()) ? static_cast<ESProxyIndex const*>(nullptr)
                                                       : &(itemsToGetFromRecords_[iIndex].front());
     }

ESRecordIndex const* edm::ESProducer::getTokenRecordIndices ( unsigned int iIndex ) const

inline

Definition at line 119 of file ESProducer.h.

References relativeConstraints::empty, and recordsUsedDuringGet_.

                                                                           {
       if (recordsUsedDuringGet_.empty()) {
         return nullptr;
       }
       return (recordsUsedDuringGet_[iIndex].empty()) ? static_cast<ESRecordIndex const*>(nullptr)
                                                      : &(recordsUsedDuringGet_[iIndex].front());
     }

bool edm::ESProducer::hasMayConsumes ( ) const

inlinenoexcept

Definition at line 133 of file ESProducer.h.

References hasMayConsumes_.

Referenced by updateFromMayConsumes().

133 { return hasMayConsumes_; }

edm::ESProducer::hasMayConsumes_

bool hasMayConsumes_

Definition: ESProducer.h:268

size_t edm::ESProducer::numberOfTokenIndices ( unsigned int iIndex ) const

inline

Definition at line 126 of file ESProducer.h.

References itemsToGetFromRecords_.

                                                            {
       if (itemsToGetFromRecords_.empty()) {
         return 0;
       }
       return itemsToGetFromRecords_[iIndex].size();
     }

ESProducer const& edm::ESProducer::operator= ( const ESProducer & )

delete

SerialTaskQueueChain& edm::ESProducer::queue ( )

inline

Definition at line 152 of file ESProducer.h.

References acquirer_, and edm::SharedResourcesAcquirer::serialQueueChain().

152 { return acquirer_.serialQueueChain(); }

edm::SharedResourcesAcquirer::serialQueueChain

SerialTaskQueueChain & serialQueueChain() const

Definition: SharedResourcesAcquirer.h:54

edm::ESProducer::acquirer_

SharedResourcesAcquirer acquirer_

Definition: ESProducer.h:266

template<typename CallbackT , typename TProduct , typename TRecord >

void edm::ESProducer::registerProduct	(	std::shared_ptr< std::pair< unsigned int, std::shared_ptr< CallbackT >>>	iCallback,
		const TProduct *	,
		const TRecord *	,
		const es::Label &	iLabel
	)

inlineprivate

Definition at line 235 of file ESProducer.h.

References edm::es::Label::default_, eostools::move(), and edm::ESProxyFactoryProducer::registerFactory().

Referenced by registerProducts().

                                                 {
       using ProxyType = eventsetup::CallbackProxy<CallbackT, TRecord, TProduct>;
       using FactoryType = eventsetup::ProxyArgumentFactoryTemplate<ProxyType, CallbackT>;
       registerFactory(std::make_unique<FactoryType>(std::move(iCallback)), iLabel.default_);
     }

template<typename CallbackT , typename TProduct , typename TRecord , int IIndex>

void edm::ESProducer::registerProduct	(	std::shared_ptr< std::pair< unsigned int, std::shared_ptr< CallbackT >>>	iCallback,
		const es::L< TProduct, IIndex > *	,
		const TRecord *	,
		const es::Label &	iLabel
	)

inlineprivate

Definition at line 245 of file ESProducer.h.

References edm::errors::Configuration, edm::es::Label::def(), edm::es::Label::labels_, eostools::move(), edm::ESProxyFactoryProducer::registerFactory(), and edm::Exception::throwThis().

                                                 {
       if (iLabel.labels_.size() <= IIndex || iLabel.labels_[IIndex] == es::Label::def()) {
         Exception::throwThis(errors::Configuration,
                              "Unnamed Label\nthe index ",
                              IIndex,
                              " was never assigned a name in the 'setWhatProduced' method");
       }
       using ProxyType = eventsetup::CallbackProxy<CallbackT, TRecord, es::L<TProduct, IIndex>>;
       using FactoryType = eventsetup::ProxyArgumentFactoryTemplate<ProxyType, CallbackT>;
       registerFactory(std::make_unique<FactoryType>(std::move(iCallback)), iLabel.labels_[IIndex]);
     }

template<typename CallbackT , typename TList , typename TRecord >

void edm::ESProducer::registerProducts	(	std::shared_ptr< std::pair< unsigned int, std::shared_ptr< CallbackT >>>	iCallback,
		const TList *	,
		const TRecord *	iRecord,
		const es::Label &	iLabel
	)

inlineprivate

Definition at line 218 of file ESProducer.h.

References eostools::move(), and registerProduct().

                                                  {
       registerProduct(iCallback, static_cast<const typename TList::tail_type*>(nullptr), iRecord, iLabel);
       registerProducts(std::move(iCallback), static_cast<const typename TList::head_type*>(nullptr), iRecord, iLabel);
     }

template<typename CallbackT , typename TRecord >

void edm::ESProducer::registerProducts	(	std::shared_ptr< std::pair< unsigned int, std::shared_ptr< CallbackT >>>	,
		const eventsetup::produce::Null *	,
		const TRecord *	,
		const es::Label &
	)

inlineprivate

Definition at line 227 of file ESProducer.h.

                                           {
       //do nothing
     }

template<typename T >

auto edm::ESProducer::setWhatProduced	(	T *	iThis,
		const es::Label &	iLabel = `{}`
	)

inlineprotected

Parameters

iThis the 'this' pointer to an inheriting class instance The method determines the Record argument and return value of the 'produce' method in order to do the registration with the EventSetup

Definition at line 163 of file ESProducer.h.

                                                            {}) {
       return setWhatProduced(iThis, &T::produce, iLabel);
     }

template<typename T >

auto edm::ESProducer::setWhatProduced	(	T *	iThis,
		const char *	iLabel
	)

inlineprotected

Definition at line 168 of file ESProducer.h.

References setWhatProduced().

                                                        {
       return setWhatProduced(iThis, es::Label(iLabel));
     }

template<typename T >

auto edm::ESProducer::setWhatProduced	(	T *	iThis,
		const std::string &	iLabel
	)

inlineprotected

Definition at line 172 of file ESProducer.h.

References setWhatProduced().

                                                             {
       return setWhatProduced(iThis, es::Label(iLabel));
     }

template<typename T , typename TDecorator >

auto edm::ESProducer::setWhatProduced	(	T *	iThis,
		const TDecorator &	iDec,
		const es::Label &	iLabel = `{}`
	)

inlineprotected

Definition at line 177 of file ESProducer.h.

                                                                                    {}) {
       return setWhatProduced(iThis, &T::produce, iDec, iLabel);
     }

template<typename T , typename TReturn , typename TRecord >

auto edm::ESProducer::setWhatProduced	(	T *	iThis,
		TReturn(T::*)(const TRecord &)	iMethod,
		const es::Label &	iLabel = `{}`
	)

inlineprotected

Parameters

iThis	the 'this' pointer to an inheriting class instance
iMethod	a member method of then inheriting class The method determines the Record argument and return value of the iMethod argument method in order to do the registration with the EventSetup

Definition at line 186 of file ESProducer.h.

                                                                                                  {}) {
       return setWhatProduced(iThis, iMethod, eventsetup::CallbackSimpleDecorator<TRecord>(), iLabel);
     }

template<typename T , typename TReturn , typename TRecord , typename TArg >

ESConsumesCollectorT<TRecord> edm::ESProducer::setWhatProduced	(	T *	iThis,
		TReturn(T::*)(const TRecord &)	iMethod,
		const TArg &	iDec,
		const es::Label &	iLabel = `{}`
	)

inlineprotected

Parameters

iThis	the 'this' pointer to an inheriting class instance
iMethod	a member method of then inheriting class
iDecorator	a class with 'pre'&'post' methods which are placed around the method call The method determines the Record argument and return value of the iMethod argument method in order to do the registration with the EventSetup

Definition at line 196 of file ESProducer.h.

                                                                           {}) {
       const auto id = consumesInfos_.size();
       using DecoratorType = typename eventsetup::DecoratorFromArg<T, TRecord, TArg>::Decorator_t;
       using CallbackType = eventsetup::Callback<T, TReturn, TRecord, DecoratorType>;
       unsigned int iovIndex = 0;  // Start with 0, but later will cycle through all of them
       auto temp = std::make_shared<CallbackType>(
           iThis, iMethod, id, createDecoratorFrom(iThis, static_cast<const TRecord*>(nullptr), iDec));
       auto callback =
           std::make_shared<std::pair<unsigned int, std::shared_ptr<CallbackType>>>(iovIndex, std::move(temp));
       registerProducts(std::move(callback),
                        static_cast<const typename eventsetup::produce::product_traits<TReturn>::type*>(nullptr),
                        static_cast<const TRecord*>(nullptr),
                        iLabel);
       consumesInfos_.push_back(std::make_unique<ESConsumesInfo>());
       return ESConsumesCollectorT<TRecord>(consumesInfos_.back().get(), id);
     }

template<typename Record >

std::optional<std::vector<ESProxyIndex> > edm::ESProducer::updateFromMayConsumes	(	unsigned int	iIndex,
		const Record &	iRecord
	)		const

inline

Definition at line 136 of file ESProducer.h.

References consumesInfos_, hasMayConsumes(), mps_fire::i, info(), itemsToGetFromRecords_, edm::eventsetup::impl::MayConsumeChooserBase< RCD >::makeChoice(), and runTheMatrix::ret.

                                                                                                                  {
       if (not hasMayConsumes()) {
         return {};
       }
       std::vector<ESProxyIndex> ret = itemsToGetFromRecords_[iIndex];
       auto const info = consumesInfos_[iIndex].get();
       for (size_t i = 0; i < info->size(); ++i) {
         auto chooserBase = (*info)[i].chooser_.get();
         if (chooserBase) {
           auto chooser = static_cast<eventsetup::impl::MayConsumeChooserBase<Record>*>(chooserBase);
           ret[i] = chooser->makeChoice(iRecord);
         }
       }
       return ret;
     }