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/ValidityInterval.h"

// system include files
#include "boost/shared_ptr.hpp"

#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 EventSetupRecord;
      class ParameterSetIDHolder;
      
class EventSetupRecordProvider {

   public:
      typedef std::map<DataKey, ComponentDescription> DataToPreferredProviderMap;
   
      EventSetupRecordProvider(EventSetupRecordKey const& iKey);
      virtual ~EventSetupRecordProvider();

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

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

      virtual std::set<EventSetupRecordKey> dependentRecords() const;
      
      std::set<ComponentDescription> proxyProviderDescriptions() const;
      
      boost::shared_ptr<DataProxyProvider> proxyProvider(ComponentDescription const&) const;

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


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

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

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

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

      void add(boost::shared_ptr<DataProxyProvider>);
      void addFinder(boost::shared_ptr<EventSetupRecordIntervalFinder>);
      void setValidityInterval(ValidityInterval const&);
      
      bool setValidityIntervalFor(IOVSyncValue const&);

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

      void usePreferred(DataToPreferredProviderMap const&);
      
      void resetProxies();
      
      boost::shared_ptr<EventSetupRecordIntervalFinder> finder() const { return finder_; }

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

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

      void resetRecordToProxyPointers(DataToPreferredProviderMap const& iMap);

   protected:
      void addProxiesToRecord(boost::shared_ptr<DataProxyProvider>,
                              DataToPreferredProviderMap const&);
      void cacheReset();
   
      virtual EventSetupRecord& record() = 0;
      
      boost::shared_ptr<EventSetupRecordIntervalFinder> swapFinder(boost::shared_ptr<EventSetupRecordIntervalFinder> iNew) {
        std::swap(iNew, finder_);
        return iNew;
      }

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

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

      void resetTransients();
      bool checkResetTransients();
      // ---------- member data --------------------------------
      EventSetupRecordKey const key_;
      ValidityInterval validityInterval_;
      boost::shared_ptr<EventSetupRecordIntervalFinder> finder_;
      std::vector<boost::shared_ptr<DataProxyProvider> > providers_;
      std::auto_ptr<std::vector<boost::shared_ptr<EventSetupRecordIntervalFinder> > > multipleFinders_;
      bool lastSyncWasBeginOfRun_;
};
   }
}

#endif