edm::ESConsumesCollector Class Reference

#include "FWCore/Framework/interface/ESConsumesCollector.h"

Inheritance diagram for edm::ESConsumesCollector:

Public Member Functions
template<typename Product , typename Record >
auto	consumesFrom (ESInputTag const &tag)
	ESConsumesCollector ()=delete
	ESConsumesCollector (ESConsumesCollector const &)=default
	ESConsumesCollector (ESConsumesCollector &&)=default
ESConsumesCollector &	operator= (ESConsumesCollector const &)=default
ESConsumesCollector &	operator= (ESConsumesCollector &&)=default

Protected Member Functions
	ESConsumesCollector (ESConsumesInfo *const iConsumer, unsigned int iTransitionID)

Private Attributes
edm::propagate_const< ESConsumesInfo * >	m_consumer {nullptr}
unsigned int	m_transitionID {0}

Detailed Description

Description: Helper class to gather consumes information for the EventSetup.

Usage: The constructor of an ESProducer module can get an instance of edm::ESConsumesCollector by calling consumesCollector() method. This instance can then be passed to helper classes in order to register the event-setup data the helper will request from an Event, LuminosityBlock or Run on behalf of the module.

Caveat: The ESConsumesCollector should be used during the time that modules are being constructed. It should not be saved and used later. It will not work if it is used to call the consumes function during beginJob, beginRun, beginLuminosity block, event processing or at any later time. As of now, an ESConsumesCollector is provided for only ESProducer subclasses–i.e. those that call setWhatProduced(this, ...).

Definition at line 44 of file ESConsumesCollector.h.

Constructor & Destructor Documentation

edm::ESConsumesCollector::ESConsumesCollector ( )

delete

edm::ESConsumesCollector::ESConsumesCollector ( ESConsumesCollector const &  )

default

edm::ESConsumesCollector::ESConsumesCollector ( ESConsumesCollector &&  )

default

edm::ESConsumesCollector::ESConsumesCollector ( ESConsumesInfo *const  iConsumer, unsigned int  iTransitionID  )

inlineexplicitprotected

Definition at line 66 of file ESConsumesCollector.h.

References m_transitionID.

        : m_consumer{iConsumer}, m_transitionID{iTransitionID} {}

Member Function Documentation

template<typename Product , typename Record >

auto edm::ESConsumesCollector::consumesFrom ( ESInputTag const &  tag )

inline

Definition at line 54 of file ESConsumesCollector.h.

References edm::ESInputTag::data(), m_consumer, m_transitionID, edm::ESInputTag::module(), and dataset::name.

                                             {
      using namespace edm::eventsetup;
      ESTokenIndex index{static_cast<ESTokenIndex::Value_t>(m_consumer->size())};
      m_consumer->emplace_back(EventSetupRecordKey::makeKey<Record>(),
                               DataKey(DataKey::makeTypeTag<Product>(), tag.data().c_str()),
                               tag.module());
      //even though m_consumer may expand, the address for
      // name().value() remains the same since it is 'moved'.
      return ESGetToken<Product, Record>{m_transitionID, index, std::get<1>(m_consumer->back()).name().value()};
    }

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

default

ESConsumesCollector& edm::ESConsumesCollector::operator= ( ESConsumesCollector &&  )

default

Member Data Documentation

edm::propagate_const<ESConsumesInfo*> edm::ESConsumesCollector::m_consumer {nullptr}

private

Definition at line 71 of file ESConsumesCollector.h.

Referenced by consumesFrom().

unsigned int edm::ESConsumesCollector::m_transitionID {0}

private

Definition at line 72 of file ESConsumesCollector.h.

Referenced by consumesFrom(), and ESConsumesCollector().