PrintEventSetupDataRetrieval.cc

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:     Services
// Class  :     PrintEventSetupDataRetrieval
//
// Implementation:
//     A service which prints which data from the EventSetup have been retrieved since the last time it checked
//
// Original Author:  Chris Jones
//         Created:  Thu Jul  9 14:30:13 CDT 2009
//

// system include files
#include <iostream>
#include <map>
#include <memory>

// user include files
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "FWCore/Framework/interface/EventSetup.h"
#include "FWCore/Framework/interface/EventSetupRecord.h"
#include "FWCore/Framework/interface/ComponentDescription.h"
#include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
#include "FWCore/Framework/interface/one/EDAnalyzer.h"
#include "FWCore/Framework/interface/EventSetupRecordKey.h"
#include "FWCore/Framework/interface/DataKey.h"
#include "FWCore/Framework/interface/MakerMacros.h"

namespace edm {
  class PrintEventSetupDataRetrieval
      : public edm::one::EDAnalyzer<edm::one::WatchRuns, edm::one::WatchLuminosityBlocks> {
  public:
    PrintEventSetupDataRetrieval(edm::ParameterSet const&);

    void analyze(edm::Event const&, edm::EventSetup const&) override;

    void beginRun(edm::Run const&, edm::EventSetup const&) override;
    void endRun(edm::Run const&, edm::EventSetup const&) override;

    void beginLuminosityBlock(edm::LuminosityBlock const&, edm::EventSetup const&) override;
    void endLuminosityBlock(edm::LuminosityBlock const&, edm::EventSetup const&) override;

    static void fillDescriptions(edm::ConfigurationDescriptions& descriptions);

  private:
    void check(EventSetup const&);
    // ---------- member data --------------------------------
    typedef std::map<eventsetup::EventSetupRecordKey,
                     std::pair<unsigned long long, std::map<eventsetup::DataKey, bool> > >
        RetrievedDataMap;

    RetrievedDataMap m_retrievedDataMap;
    std::vector<eventsetup::EventSetupRecordKey> m_recordKeys;
    const bool m_printProviders;
    const bool m_checkDuringBeginRun;
    const bool m_checkDuringBeginLumi;
    const bool m_checkDuringEvent;
  };
  //
  // constants, enums and typedefs
  //

  //
  // static data member definitions
  //

  //
  // constructors and destructor
  //
  PrintEventSetupDataRetrieval::PrintEventSetupDataRetrieval(const ParameterSet& iPS)
      : m_printProviders(iPS.getUntrackedParameter<bool>("printProviders")),
        m_checkDuringBeginRun(iPS.getUntrackedParameter<bool>("checkDuringBeginRun")),
        m_checkDuringBeginLumi(iPS.getUntrackedParameter<bool>("checkDuringBeginLumi")),
        m_checkDuringEvent(iPS.getUntrackedParameter<bool>("checkDuringEvent")) {}

  // PrintEventSetupDataRetrieval::PrintEventSetupDataRetrieval(const PrintEventSetupDataRetrieval& rhs)
  // {
  //    // do actual copying here;
  // }

  //PrintEventSetupDataRetrieval::~PrintEventSetupDataRetrieval()
  //{
  //}

  void PrintEventSetupDataRetrieval::fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
    edm::ParameterSetDescription desc;
    desc.addUntracked<bool>("printProviders", false)
        ->setComment("If 'true' also print which ES module provides the data");
    desc.addUntracked<bool>("checkDuringBeginRun", false)
        ->setComment("If 'true' check for retrieved data during each begin run is processed");
    desc.addUntracked<bool>("checkDuringBeginLumi", false)
        ->setComment("If 'true' check for retrieved data during each begin lumi is processed");
    desc.addUntracked<bool>("checkDuringEvent", true)
        ->setComment("If 'true' check for retrieved data during an event is processed");
    descriptions.add("PrintEventSetupDataRetrieval", desc);
    descriptions.setComment("This analyzer reports when EventSetup data is retrieved by a module in the job.");
  }

  //
  // assignment operators
  //
  // const PrintEventSetupDataRetrieval& PrintEventSetupDataRetrieval::operator=(const PrintEventSetupDataRetrieval& rhs)
  // {
  //   //An exception safe implementation is
  //   PrintEventSetupDataRetrieval temp(rhs);
  //   swap(rhs);
  //
  //   return *this;
  // }

  //
  // member functions
  //
  void PrintEventSetupDataRetrieval::analyze(Event const&, EventSetup const& iES) {
    if (m_checkDuringEvent) {
      check(iES);
    }
  }

  void PrintEventSetupDataRetrieval::beginRun(Run const&, EventSetup const& iES) {
    if (m_checkDuringBeginRun) {
      check(iES);
    }
  }

  void PrintEventSetupDataRetrieval::endRun(Run const&, EventSetup const&) {}

  void PrintEventSetupDataRetrieval::beginLuminosityBlock(LuminosityBlock const&, EventSetup const& iES) {
    if (m_checkDuringBeginLumi) {
      check(iES);
    }
  }

  void PrintEventSetupDataRetrieval::endLuminosityBlock(LuminosityBlock const&, EventSetup const&) {}

  void PrintEventSetupDataRetrieval::check(EventSetup const& iES) {
    //std::cout <<"postProcessEvent"<<std::endl;
    m_recordKeys.clear();
    iES.fillAvailableRecordKeys(m_recordKeys);

    std::unique_ptr<LogSystem> msg;
    for (std::vector<eventsetup::EventSetupRecordKey>::const_iterator it = m_recordKeys.begin(),
                                                                      itEnd = m_recordKeys.end();
         it != itEnd;
         ++it) {
      //std::cout <<"  "<<it->name()<<std::endl;
      auto r = iES.find(*it);
      assert(r);

      RetrievedDataMap::iterator itRetrievedData = m_retrievedDataMap.find(*it);
      if (itRetrievedData == m_retrievedDataMap.end()) {
        itRetrievedData =
            m_retrievedDataMap
                .insert(std::make_pair(*it, std::pair<unsigned long long, std::map<eventsetup::DataKey, bool> >()))
                .first;
        itRetrievedData->second.first = r->cacheIdentifier();
        std::vector<eventsetup::DataKey> keys;
        r->fillRegisteredDataKeys(keys);
        for (std::vector<eventsetup::DataKey>::const_iterator itData = keys.begin(), itDataEnd = keys.end();
             itData != itDataEnd;
             ++itData) {
          itRetrievedData->second.second.insert(std::make_pair(*itData, false));
        }
      }
      RetrievedDataMap::value_type& retrievedData = *itRetrievedData;
      if (itRetrievedData->second.first != r->cacheIdentifier()) {
        itRetrievedData->second.first = r->cacheIdentifier();
        for (std::map<eventsetup::DataKey, bool>::iterator itDatum = retrievedData.second.second.begin(),
                                                           itDatumEnd = retrievedData.second.second.end();
             itDatum != itDatumEnd;
             ++itDatum) {
          itDatum->second = false;
        }
      }

      for (std::map<eventsetup::DataKey, bool>::iterator itDatum = retrievedData.second.second.begin(),
                                                         itDatumEnd = retrievedData.second.second.end();
           itDatum != itDatumEnd;
           ++itDatum) {
        bool wasGotten = r->wasGotten(itDatum->first);
        if (wasGotten != itDatum->second) {
          if (not msg)
            msg = std::make_unique<LogSystem>("ESContent");
          else
            *msg << "\n";
          itDatum->second = wasGotten;
          *msg << "Retrieved> record:" << it->name() << " data:" << itDatum->first.type().name() << " '"
               << itDatum->first.name().value() << "'";
          if (m_printProviders) {
            const edm::eventsetup::ComponentDescription* d = r->providerDescription(itDatum->first);
            assert(nullptr != d);
            *msg << " provider:" << d->type_ << " '" << d->label_ << "'";
          }
        }
      }
    }
  }

  //
  // const member functions
  //

  //
  // static member functions
  //
}  // namespace edm

//define this as a plug-in
using edm::PrintEventSetupDataRetrieval;
DEFINE_FWK_MODULE(PrintEventSetupDataRetrieval);