EventSetupRecordProvider.h

Go to the documentation of this file.

#ifndef FWCore_Framework_EventSetupRecordProvider_h
#define FWCore_Framework_EventSetupRecordProvider_h
// -*- C++ -*-
//
// Package:     Framework
// Class  :     EventSetupRecordProvider
//
//
// Author:      Chris Jones
// Created:     Fri Mar 25 19:02:23 EST 2005
//

// user include files
#include "FWCore/Framework/interface/EventSetupRecordKey.h"
#include "FWCore/Framework/interface/EventSetupRecordImpl.h"
#include "FWCore/Framework/interface/ValidityInterval.h"
#include "FWCore/Utilities/interface/get_underlying_safe.h"

// system include files

#include <map>
#include <memory>
#include <set>
#include <vector>

// forward declarations
namespace edm {
  class EventSetupRecordIntervalFinder;

  namespace eventsetup {
    struct ComponentDescription;
    class DataKey;
    class DataProxyProvider;
    class EventSetupProvider;
    class EventSetupRecordImpl;
    class ParameterSetIDHolder;

    class EventSetupRecordProvider {
    public:
      typedef std::map<DataKey, ComponentDescription> DataToPreferredProviderMap;

      EventSetupRecordProvider(EventSetupRecordKey const& iKey);

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

      ValidityInterval const& validityInterval() const { return validityInterval_; }
      EventSetupRecordKey const& key() const { return key_; }

      EventSetupRecordImpl const& record() const { return record_; }
      EventSetupRecordImpl& record() { return record_; }

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

      std::set<ComponentDescription> proxyProviderDescriptions() const;

      std::vector<DataKey> registeredDataKeys() const;

      std::vector<ComponentDescription const*> componentsForRegisteredDataKeys() const;
      // ---------- member functions ---------------------------

      std::shared_ptr<DataProxyProvider> proxyProvider(ComponentDescription const&);

      std::shared_ptr<DataProxyProvider> proxyProvider(ParameterSetIDHolder const&);

      void resetProxyProvider(ParameterSetIDHolder const&, std::shared_ptr<DataProxyProvider> const&);

      void addRecordTo(EventSetupProvider&);
      void addRecordToIfValid(EventSetupProvider&, IOVSyncValue const&);

      void add(std::shared_ptr<DataProxyProvider>);
      void addFinder(std::shared_ptr<EventSetupRecordIntervalFinder>);
      void setValidityInterval(ValidityInterval const&);

      bool setValidityIntervalFor(IOVSyncValue const&);

      void setDependentProviders(std::vector<std::shared_ptr<EventSetupRecordProvider>> const&);

      void usePreferred(DataToPreferredProviderMap const&);

      void resetProxies();

      std::shared_ptr<EventSetupRecordIntervalFinder const> finder() const { return get_underlying_safe(finder_); }
      std::shared_ptr<EventSetupRecordIntervalFinder>& finder() { return get_underlying_safe(finder_); }

      void getReferencedESProducers(
          std::map<EventSetupRecordKey, std::vector<ComponentDescription const*>>& referencedESProducers);

      void fillReferencedDataKeys(std::map<DataKey, ComponentDescription const*>& referencedDataKeys) const;

      void resetRecordToProxyPointers(DataToPreferredProviderMap const& iMap);

    protected:
      void addProxiesToRecordHelper(edm::propagate_const<std::shared_ptr<DataProxyProvider>>& dpp,
                                    DataToPreferredProviderMap const& mp) {
        addProxiesToRecord(get_underlying_safe(dpp), mp);
      }
      void addProxiesToRecord(std::shared_ptr<DataProxyProvider>, DataToPreferredProviderMap const&);
      void cacheReset();

      std::shared_ptr<EventSetupRecordIntervalFinder> swapFinder(std::shared_ptr<EventSetupRecordIntervalFinder> iNew) {
        std::swap(iNew, finder());
        return iNew;
      }

    private:
      EventSetupRecordProvider(EventSetupRecordProvider const&) = delete;  // stop default

      EventSetupRecordProvider const& operator=(EventSetupRecordProvider const&) = delete;  // stop default

      void resetTransients();
      bool checkResetTransients();
      // ---------- member data --------------------------------
      EventSetupRecordImpl record_;
      EventSetupRecordKey const key_;
      ValidityInterval validityInterval_;
      edm::propagate_const<std::shared_ptr<EventSetupRecordIntervalFinder>> finder_;
      std::vector<edm::propagate_const<std::shared_ptr<DataProxyProvider>>> providers_;
      std::unique_ptr<std::vector<edm::propagate_const<std::shared_ptr<EventSetupRecordIntervalFinder>>>>
          multipleFinders_;
      bool lastSyncWasBeginOfRun_;
    };
  }  // namespace eventsetup
}  // namespace edm

#endif