EventSetup.h

Go to the documentation of this file.

#ifndef FWCore_Framework_EventSetup_h
#define FWCore_Framework_EventSetup_h
// -*- C++ -*-
//
// Package:     Framework
// Class:      EventSetup
// 
//
// Author:      Chris Jones
// Created:     Thu Mar 24 13:50:04 EST 2005
//

// system include files
#include <map>
#include <string>
#include <vector>
#include <cassert>
#include "boost/type_traits/is_base_and_derived.hpp"
#include "boost/static_assert.hpp"
// user include files
#include "FWCore/Framework/interface/IOVSyncValue.h"
#include "FWCore/Framework/interface/EventSetupRecordKey.h"
#include "FWCore/Framework/interface/HCMethods.h"
#include "FWCore/Framework/interface/eventSetupGetImplementation.h"

// forward declarations

namespace edm {
   class ESInputTag;
   
   namespace eventsetup {
      class EventSetupProvider;
      class EventSetupRecord;
      template<class T> struct data_default_record_trait;
   }
class EventSetup
{
   friend class eventsetup::EventSetupProvider;
   public:
      virtual ~EventSetup();

      // ---------- const member functions ---------------------
      template< typename T>
         const T& get() const {
            //NOTE: this will catch the case where T does not inherit from EventSetupRecord
            //  HOWEVER the error message under gcc 3.x is awful
            BOOST_STATIC_ASSERT((boost::is_base_and_derived<edm::eventsetup::EventSetupRecord, T>::value));
            const T* value = 0;
            eventSetupGetImplementation(*this, value);
            //NOTE: by construction, eventSetupGetImplementation should thrown an exception rather than return a null value
            assert(0 != value);
            return *value;
         }
      template< typename T>
         void getData(T& iHolder) const {
            typedef typename T::value_type data_type;
            typedef typename eventsetup::data_default_record_trait<data_type>::type RecordT;
            const RecordT& rec = this->get<RecordT>();
            rec.get(iHolder);
         }
      template< typename T>
         void getData(const std::string& iLabel, T& iHolder) const {
            typedef typename T::value_type data_type;
            typedef typename eventsetup::data_default_record_trait<data_type>::type RecordT;
            const RecordT& rec = this->get<RecordT>();
            rec.get(iLabel,iHolder);
         }

      template< typename T>
        void getData(const edm::ESInputTag& iTag, T& iHolder) const {
           typedef typename T::value_type data_type;
           typedef typename eventsetup::data_default_record_trait<data_type>::type RecordT;
           const RecordT& rec = this->get<RecordT>();
           rec.get(iTag,iHolder);
        }
   
      const IOVSyncValue& iovSyncValue() const { return syncValue_;}

      const eventsetup::EventSetupRecord* find(const eventsetup::EventSetupRecordKey&) const;
      
      void fillAvailableRecordKeys(std::vector<eventsetup::EventSetupRecordKey>& oToFill) const;
      
      // ---------- static member functions --------------------

      // ---------- member functions ---------------------------
      template< typename T>
         void
         getAvoidCompilerBug(const T*& iValue) const {
            iValue = &(get<T>());
         }
   protected:
      //Only called by EventSetupProvider
      void setIOVSyncValue(const IOVSyncValue&);

      void add(const eventsetup::EventSetupRecord& iRecord);
      
      void clear();
      
   private:
      EventSetup();
      
      EventSetup(EventSetup const&); // stop default

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

      void insert(const eventsetup::EventSetupRecordKey&,
                  const eventsetup::EventSetupRecord*);

      // ---------- member data --------------------------------
      IOVSyncValue syncValue_;
      
      //NOTE: the records are not owned
      std::map<eventsetup::EventSetupRecordKey, eventsetup::EventSetupRecord const *> recordMap_;
};

}
#endif