DataProxyProvider.h

Go to the documentation of this file.

#ifndef Framework_DataProxyProvider_h
#define Framework_DataProxyProvider_h
// -*- C++ -*-
//
// Package:     Framework
// Class  :     DataProxyProvider
//
//
// Author:      Chris Jones
// Created:     Mon Mar 28 14:21:58 EST 2005
//

// system include files
#include <map>
#include <memory>
#include <set>
#include <string>
#include <vector>

// user include files
#include "FWCore/Framework/interface/EventSetupRecordKey.h"
#include "FWCore/Framework/interface/DataKey.h"
#include "FWCore/Framework/interface/ComponentDescription.h"
#include "FWCore/Utilities/interface/propagate_const.h"

// forward declarations
namespace edm {
  class ValidityInterval;
  class ParameterSet;
  class ConfigurationDescriptions;
  namespace eventsetup {
    class DataProxy;
    class ESRecordsToProxyIndices;

    class DataProxyProvider {
    public:
      typedef std::vector<EventSetupRecordKey> Keys;
      typedef std::vector<std::pair<DataKey, edm::propagate_const<std::shared_ptr<DataProxy>>>> KeyedProxies;
      typedef std::map<EventSetupRecordKey, KeyedProxies> RecordProxies;

      DataProxyProvider();
      virtual ~DataProxyProvider() noexcept(false);

      // ---------- const member functions ---------------------
      bool isUsingRecord(const EventSetupRecordKey&) const;

      std::set<EventSetupRecordKey> usingRecords() const;

      const KeyedProxies& keyedProxies(const EventSetupRecordKey& iRecordKey) const;

      const ComponentDescription& description() const { return description_; }
      // ---------- static member functions --------------------
      static void prevalidate(ConfigurationDescriptions&);

      // ---------- member functions ---------------------------

      virtual void updateLookup(ESRecordsToProxyIndices const&);

      virtual void newInterval(const EventSetupRecordKey& iRecordType, const ValidityInterval& iInterval) = 0;

      void setDescription(const ComponentDescription& iDescription) { description_ = iDescription; }

      void setAppendToDataLabel(const edm::ParameterSet&);

      void resetProxies(const EventSetupRecordKey& iRecordType);
      void resetProxiesIfTransient(const EventSetupRecordKey& iRecordType);

    protected:
      template <class T>
      void usingRecord() {
        usingRecordWithKey(EventSetupRecordKey::makeKey<T>());
      }

      void usingRecordWithKey(const EventSetupRecordKey&);

      void invalidateProxies(const EventSetupRecordKey& iRecordKey);

      virtual void registerProxies(const EventSetupRecordKey& iRecordKey, KeyedProxies& aProxyList) = 0;

      void eraseAll(const EventSetupRecordKey& iRecordKey);

    private:
      DataProxyProvider(const DataProxyProvider&);  // stop default

      const DataProxyProvider& operator=(const DataProxyProvider&);  // stop default

      // ---------- member data --------------------------------
      RecordProxies recordProxies_;
      ComponentDescription description_;
      std::string appendToDataLabel_;
    };

    template <class ProxyT>
    inline void insertProxy(DataProxyProvider::KeyedProxies& iList,
                            std::shared_ptr<ProxyT> iProxy,
                            const char* iName = "") {
      iList.push_back(DataProxyProvider::KeyedProxies::value_type(
          DataKey(DataKey::makeTypeTag<typename ProxyT::value_type>(), iName), iProxy));
    }

  }  // namespace eventsetup
}  // namespace edm
#endif