edm::ESConsumesCollector Class Reference

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

Inheritance diagram for edm::ESConsumesCollector:

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

Protected Member Functions
	ESConsumesCollector (ESConsumesInfo *const iConsumer, unsigned int iTransitionID)
template<typename Product , typename Record , typename Collector , typename PTag >
auto	registerMayConsume (std::unique_ptr< Collector > iCollector, PTag const &productTag)

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 64 of file ESConsumesCollector.h.

Constructor & Destructor Documentation

ESConsumesCollector() [1/4]

edm::ESConsumesCollector::ESConsumesCollector ( )

delete

ESConsumesCollector() [2/4]

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

delete

ESConsumesCollector() [3/4]

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

default

ESConsumesCollector() [4/4]

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

inlineexplicitprotected

Definition at line 101 of file ESConsumesCollector.h.

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

Member Function Documentation

consumes() [1/2]

ESConsumesCollectorAdaptor edm::ESConsumesCollector::consumes ( )

inline

Definition at line 204 of file ESConsumesCollector.h.

Referenced by registerMayConsume(), HcalDbProducer::ServiceTokenImpl< ProductType, RecordType, LABEL, EffectiveType >::setConsumes(), and SiPixelQualityESProducer::Tokens::Tokens().

{ return ESConsumesCollectorAdaptor(this); }

consumes() [2/2]

ESConsumesCollectorWithTagAdaptor edm::ESConsumesCollector::consumes ( ESInputTag  tag )

inline

Definition at line 205 of file ESConsumesCollector.h.

References eostools::move(), and makeGlobalPositionRcd_cfg::tag.

                                                                                       {
    return ESConsumesCollectorWithTagAdaptor(this, std::move(tag));
  }

consumesFrom() [1/2]

template<typename Product , typename Record >

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

inline

Definition at line 74 of file ESConsumesCollector.h.

References m_consumer, m_transitionID, and makeGlobalPositionRcd_cfg::tag.

Referenced by CaloGeometryBuilder::CaloGeometryBuilder(), SiStripGainESProducer::GainGetterT< Record >::GainGetterT(), calogeometryDBEPimpl::AdditionalTokens< CaloTowerGeometry >::makeTokens(), calogeometryDBEPimpl::AdditionalTokens< HcalGeometry >::makeTokens(), calogeometryDBEPimpl::AdditionalTokens< HGCalGeometry >::makeTokens(), SiStripGainSimESProducer::TokenLabel::TokenLabel(), and SiStripDelayESProducer::TokenSign::TokenSign().

                                             {
      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(),
                               nullptr);
      //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, m_consumer->back().productKey_.name().value()};
    }

consumesFrom() [2/2]

template<typename Product , typename Record >

auto edm::ESConsumesCollector::consumesFrom ( )

inline

Definition at line 87 of file ESConsumesCollector.h.

References m_consumer, and m_transitionID.

                        {
      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>(), ""), "", nullptr);
      //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, m_consumer->back().productKey_.name().value()};
    }

operator=() [1/2]

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

delete

operator=() [2/2]

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

default

registerMayConsume()

template<typename Product , typename Record , typename Collector , typename PTag >

auto edm::ESConsumesCollector::registerMayConsume ( std::unique_ptr< Collector >  iCollector, PTag const &  productTag  )

inlineprotected

Definition at line 105 of file ESConsumesCollector.h.

References consumes(), m_consumer, m_transitionID, and eostools::move().

                                                                                         {
      //NOTE: for now, just treat like standard consumes request for the product needed to
      // do the decision
      iCollector->token() = consumes(productTag.inputTag());

      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>(), "@mayConsume"),
                               "@mayConsume",
                               std::move(iCollector));
      //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, m_consumer->back().productKey_.name().value()};
    }

Member Data Documentation

m_consumer

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

private

Definition at line 123 of file ESConsumesCollector.h.

Referenced by edm::ESConsumesCollectorAdaptor::consumes(), edm::ESConsumesCollectorWithTagAdaptor::consumes(), consumesFrom(), and registerMayConsume().

m_transitionID

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

private

Definition at line 124 of file ESConsumesCollector.h.

Referenced by consumesFrom(), and registerMayConsume().