EDFilterBase.h

Go to the documentation of this file.

#ifndef FWCore_Framework_stream_EDFilterBase_h
#define FWCore_Framework_stream_EDFilterBase_h
// -*- C++ -*-
//
// Package:     FWCore/Framework
// Class  :     EDFilterBase
// 
//
// Original Author:  Chris Jones
//         Created:  Fri, 02 Aug 2013 00:11:27 GMT
//

// system include files

// user include files
#include "FWCore/Framework/interface/ProducerBase.h"
#include "FWCore/Framework/interface/EDConsumerBase.h"
#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "FWCore/Framework/interface/stream/EDFilterAdaptor.h"
#include "DataFormats/Provenance/interface/ModuleDescription.h"
#include "FWCore/ParameterSet/interface/ParameterSetfwd.h"

// forward declarations
namespace edm {
  class ProductRegistry;
  class ThinnedAssociationsHelper;

  namespace stream {
    class EDFilterAdaptorBase;
    template<typename> class ProducingModuleAdaptorBase;
    
    class EDFilterBase : public edm::ProducerBase, public edm::EDConsumerBase
    {
      //This needs access to the parentage cache info
      friend class EDFilterAdaptorBase;
      friend class ProducingModuleAdaptorBase<EDFilterBase>;

    public:
      typedef EDFilterAdaptorBase ModuleType;


      EDFilterBase();
      virtual ~EDFilterBase();
      
      static void fillDescriptions(ConfigurationDescriptions& descriptions);
      static void prevalidate(ConfigurationDescriptions& descriptions);
      static const std::string& baseType();
      
      // Warning: the returned moduleDescription will be invalid during construction
      ModuleDescription const& moduleDescription() const {
        return *moduleDescriptionPtr_;
      }
    private:
      EDFilterBase(const EDFilterBase&) = delete; // stop default
      
      const EDFilterBase& operator=(const EDFilterBase&) = delete; // stop default
      
      virtual void beginStream(StreamID) {}
      virtual void beginRun(edm::Run const&, edm::EventSetup const&) {}
      virtual void beginLuminosityBlock(edm::LuminosityBlock const&, edm::EventSetup const&) {}
      virtual bool filter(Event&, EventSetup const&) = 0;
      virtual void endLuminosityBlock(edm::LuminosityBlock const&, edm::EventSetup const&) {}
      virtual void endRun(edm::Run const&, edm::EventSetup const&) {}
      virtual void endStream(){}

      virtual void preForkReleaseResources() {}
      virtual void postForkReacquireResources(unsigned int /*iChildIndex*/, unsigned int /*iNumberOfChildren*/) {}
      virtual void registerThinnedAssociations(ProductRegistry const&,
                                               ThinnedAssociationsHelper&) { }

      void setModuleDescriptionPtr(ModuleDescription const* iDesc) {
        moduleDescriptionPtr_ = iDesc;
      }
      // ---------- member data --------------------------------

      std::vector<BranchID> previousParentage_;
      ParentageID previousParentageId_;
      ModuleDescription const* moduleDescriptionPtr_;
    };
  }
}
#endif