edm::eventsetup::DataProxyProvider Class Reference

#include <DataProxyProvider.h>

Inheritance diagram for edm::eventsetup::DataProxyProvider:

Classes
class	DataProxyContainer
class	KeyedProxies
struct	PerRecordInfo

Public Member Functions
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)
virtual void	updateLookup (ESRecordsToProxyIndices const &)
std::set< EventSetupRecordKey >	usingRecords () const
virtual	~DataProxyProvider () noexcept(false)

Static Public Member Functions
static void	prevalidate (ConfigurationDescriptions &)

Protected Types
using	KeyedProxiesVector = std::vector< std::pair< DataKey, std::shared_ptr< DataProxy > >>

Protected Member Functions
virtual KeyedProxiesVector	registerProxies (const EventSetupRecordKey &, unsigned int iovIndex)=0
template<class T >
void	usingRecord ()
void	usingRecordWithKey (const EventSetupRecordKey &key)

Private Attributes
std::string	appendToDataLabel_
DataProxyContainer	dataProxyContainer_
ComponentDescription	description_

Detailed Description

Description: Lowest level base class for modules which produce data for the EventSetup system.

Usage:

In most cases, the methods in this class are used exclusively by the Framework. Usually, EventSetup modules producing data inherit from the ESProducer base class which inherits from this class. The ESProducer base class takes care of overriding the registerProxies function and calling usingRecord or usingRecordWithKey.

In cases where the ESProducer base class is not used (PoolDBESSource/ CondDBESSource is the main such class) then the registerProxies function must be overridden. For the same EventSetupRecordKey, the vector returned should contain the same DataKeys in the same order for all the different iovIndexes. DataProxies associated with the same EventSetupRecordKey should have caches that use different memory, but other than that they should also be the same.

Classes that derive from this class should also call usingRecord or usingRecordWithKey in their constructor to announce the records they provide data for.

All other functions are intended for use by the Framework or tests and should not be called in classes derived from DataProxyProvider. They are primarily used when initializing the EventSetup system so the DataProxies are available for use when needed.

Definition at line 64 of file DataProxyProvider.h.

Member Typedef Documentation

KeyedProxiesVector

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

protected

Definition at line 196 of file DataProxyProvider.h.

Constructor & Destructor Documentation

DataProxyProvider() [1/2]

edm::eventsetup::DataProxyProvider::DataProxyProvider

(

)

Definition at line 31 of file DataProxyProvider.cc.

{}

DataProxyProvider() [2/2]

edm::eventsetup::DataProxyProvider::DataProxyProvider ( const DataProxyProvider &  )

delete

~DataProxyProvider()

edm::eventsetup::DataProxyProvider::~DataProxyProvider ( )

virtualnoexcept

Definition at line 33 of file DataProxyProvider.cc.

{}

Member Function Documentation

createKeyedProxies()

void edm::eventsetup::DataProxyProvider::createKeyedProxies ( EventSetupRecordKey const &  key, unsigned int  nConcurrentIOVs  )

inline

Definition at line 166 of file DataProxyProvider.h.

References edm::eventsetup::DataProxyProvider::DataProxyContainer::createKeyedProxies(), dataProxyContainer_, initConcurrentIOVs(), and crabWrapper::key.

                                                                                            {
        dataProxyContainer_.createKeyedProxies(key, nConcurrentIOVs);
        initConcurrentIOVs(key, nConcurrentIOVs);
      }

description()

const ComponentDescription& edm::eventsetup::DataProxyProvider::description ( ) const

inline

Definition at line 171 of file DataProxyProvider.h.

References description_.

Referenced by keyedProxies(), edm::eventsetup::EventSetupRecordProvider::proxyProvider(), and edm::eventsetup::EventSetupRecordProvider::proxyProviderDescriptions().

{ return description_; }

fillRecordsNotAllowingConcurrentIOVs()

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

inline

Definition at line 160 of file DataProxyProvider.h.

References dataProxyContainer_, and edm::eventsetup::DataProxyProvider::DataProxyContainer::fillRecordsNotAllowingConcurrentIOVs().

                                                                                                                     {
        dataProxyContainer_.fillRecordsNotAllowingConcurrentIOVs(recordsNotAllowingConcurrentIOVs);
      }

initConcurrentIOVs()

virtual void edm::eventsetup::DataProxyProvider::initConcurrentIOVs ( EventSetupRecordKey const &  key, unsigned int  nConcurrentIOVs  )

inlinevirtual

Reimplemented in CondDBESSource, edmtest::TestESConcurrentSource, and edmtest::TestESSource.

Definition at line 164 of file DataProxyProvider.h.

Referenced by createKeyedProxies().

{}

isUsingRecord()

bool edm::eventsetup::DataProxyProvider::isUsingRecord ( const EventSetupRecordKey &  key ) const

inline

Definition at line 158 of file DataProxyProvider.h.

References dataProxyContainer_, edm::eventsetup::DataProxyProvider::DataProxyContainer::isUsingRecord(), and crabWrapper::key.

{ return dataProxyContainer_.isUsingRecord(key); }

keyedProxies()

DataProxyProvider::KeyedProxies & edm::eventsetup::DataProxyProvider::keyedProxies	(	const EventSetupRecordKey &	iRecordKey,
		unsigned int	iovIndex = 0
	)

Definition at line 191 of file DataProxyProvider.cc.

References appendToDataLabel_, dataProxyContainer_, description(), edm::eventsetup::DataProxyProvider::KeyedProxies::insert(), edm::eventsetup::DataProxyProvider::DataProxyContainer::keyedProxies(), eostools::move(), registerProxies(), AlCaHLTBitMon_QueryRunRegistry::string, edm::eventsetup::swap(), groupFilesInBlocks::temp, and edm::eventsetup::DataProxyProvider::KeyedProxies::unInitialized().

                                                                                            {
      KeyedProxies& keyedProxies = dataProxyContainer_.keyedProxies(iRecordKey, iovIndex);

      if (keyedProxies.unInitialized()) {
        //delayed registration
        std::vector<std::pair<DataKey, std::shared_ptr<DataProxy>>> keyedProxiesVector =
            registerProxies(iRecordKey, iovIndex);
        keyedProxies.insert(std::move(keyedProxiesVector), appendToDataLabel_);

        bool mustChangeLabels = (!appendToDataLabel_.empty());
        for (auto keyedProxy : keyedProxies) {
          keyedProxy.dataProxy_->setProviderDescription(&description());
          if (mustChangeLabels) {
            //Using swap is fine since
            // 1) the data structure is not a map and so we have not sorted on the keys
            // 2) this is the first time filling this so no outside agency has yet seen
            //   the label and therefore can not be dependent upon its value
            std::string temp(std::string(keyedProxy.dataKey_.name().value()) + appendToDataLabel_);
            DataKey newKey(keyedProxy.dataKey_.type(), temp.c_str());
            swap(keyedProxy.dataKey_, newKey);
          }
        }
      }
      return keyedProxies;
    }

operator=()

const DataProxyProvider& edm::eventsetup::DataProxyProvider::operator= ( const DataProxyProvider &  )

delete

prevalidate()

void edm::eventsetup::DataProxyProvider::prevalidate ( ConfigurationDescriptions &  iDesc )

static

Used to add parameters available to all inheriting classes

Definition at line 220 of file DataProxyProvider.cc.

References edm::ParameterSetDescription::add(), edm::ConfigurationDescriptions::defaultDescription(), edm::ParameterSetDescription::isLabelUnused(), edm::eventsetup::kAppendToDataLabel(), AlCaHLTBitMon_QueryRunRegistry::string, and findQualityFiles::v.

Referenced by ALPAKA_ACCELERATOR_NAMESPACE::ESProducer::prevalidate().

                                                                        {
      if (iDesc.defaultDescription()) {
        if (iDesc.defaultDescription()->isLabelUnused(kAppendToDataLabel)) {
          iDesc.defaultDescription()->add<std::string>(kAppendToDataLabel, std::string(""));
        }
      }
      for (auto& v : iDesc) {
        if (v.second.isLabelUnused(kAppendToDataLabel)) {
          v.second.add<std::string>(kAppendToDataLabel, std::string(""));
        }
      }
    }

registerProxies()

virtual KeyedProxiesVector edm::eventsetup::DataProxyProvider::registerProxies ( const EventSetupRecordKey &  , unsigned int  iovIndex  )

protectedpure virtual

Implemented in edmtest::ESTestDataProxyProviderJ, FWLiteESSource, CondDBESSource, edm::ESProxyFactoryProducer, edmtest::TestESConcurrentSource, edmtest::TestESSource, and edm::test::EventSetupTestHelper.

Referenced by keyedProxies().

setAppendToDataLabel()

void edm::eventsetup::DataProxyProvider::setAppendToDataLabel

(

const edm::ParameterSet &

iToAppend

)

This method is only to be called by the framework, it sets the string which will be appended to the labels of all data products being produced

Definition at line 180 of file DataProxyProvider.cc.

References appendToDataLabel_, cms::cuda::assert(), edm::ParameterSet::exists(), edm::ParameterSet::getParameter(), and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by edm::eventsetup::ComponentMaker< edm::eventsetup::LooperMakerTraits, TType >::setPostConstruction().

                                                                                 {
      std::string oldValue(appendToDataLabel_);
      //this can only be changed once and the default value is the empty string
      assert(oldValue.empty());

      const std::string kParamName("appendToDataLabel");
      if (iToAppend.exists(kParamName)) {
        appendToDataLabel_ = iToAppend.getParameter<std::string>(kParamName);
      }
    }

setDescription()

void edm::eventsetup::DataProxyProvider::setDescription ( const ComponentDescription &  iDescription )

inline

Definition at line 175 of file DataProxyProvider.h.

References description_.

Referenced by edm::eventsetup::ComponentMaker< edm::eventsetup::LooperMakerTraits, TType >::setDescription().

{ description_ = iDescription; }

updateLookup()

void edm::eventsetup::DataProxyProvider::updateLookup ( eventsetup::ESRecordsToProxyIndices const &  )

virtual

Reimplemented in edm::ESProducer.

Definition at line 178 of file DataProxyProvider.cc.

{}

usingRecord()

template<class T >

void edm::eventsetup::DataProxyProvider::usingRecord ( )

inlineprotected

Definition at line 190 of file DataProxyProvider.h.

References usingRecordWithKey().

                         {
        usingRecordWithKey(EventSetupRecordKey::makeKey<T>());
      }

usingRecords()

std::set<EventSetupRecordKey> edm::eventsetup::DataProxyProvider::usingRecords ( ) const

inline

Definition at line 159 of file DataProxyProvider.h.

References dataProxyContainer_, and edm::eventsetup::DataProxyProvider::DataProxyContainer::usingRecords().

{ return dataProxyContainer_.usingRecords(); }

usingRecordWithKey()

void edm::eventsetup::DataProxyProvider::usingRecordWithKey ( const EventSetupRecordKey &  key )

inlineprotected

Definition at line 194 of file DataProxyProvider.h.

References dataProxyContainer_, crabWrapper::key, and edm::eventsetup::DataProxyProvider::DataProxyContainer::usingRecordWithKey().

Referenced by CondDBESSource::CondDBESSource(), FWLiteESSource::delaySettingRecords(), edm::ESProxyFactoryProducer::registerFactoryWithKey(), and usingRecord().

{ dataProxyContainer_.usingRecordWithKey(key); }

Member Data Documentation

appendToDataLabel_

std::string edm::eventsetup::DataProxyProvider::appendToDataLabel_

private

Definition at line 203 of file DataProxyProvider.h.

Referenced by keyedProxies(), and setAppendToDataLabel().

dataProxyContainer_

DataProxyContainer edm::eventsetup::DataProxyProvider::dataProxyContainer_

private

Definition at line 201 of file DataProxyProvider.h.

Referenced by edm::eventsetup::DataProxyProvider::KeyedProxies::contains(), createKeyedProxies(), fillRecordsNotAllowingConcurrentIOVs(), edm::eventsetup::DataProxyProvider::KeyedProxies::insert(), isUsingRecord(), keyedProxies(), edm::eventsetup::DataProxyProvider::KeyedProxies::recordKey(), edm::eventsetup::DataProxyProvider::KeyedProxies::size(), usingRecords(), and usingRecordWithKey().

description_

ComponentDescription edm::eventsetup::DataProxyProvider::description_

private

Definition at line 202 of file DataProxyProvider.h.

Referenced by description(), and setDescription().