OutputModuleBase.h

Go to the documentation of this file.

#ifndef FWCore_Framework_one_OutputModuleBase_h
#define FWCore_Framework_one_OutputModuleBase_h
// -*- C++ -*-
//
// Package:     FWCore/Framework
// Class  :     OutputModuleBase
//
//
// Original Author:  Chris Jones
//         Created:  Wed, 31 Jul 2013 15:37:16 GMT
//

// system include files

// user include files
#include "FWCore/Framework/interface/OutputModuleCore.h"
#include "FWCore/Framework/interface/SharedResourcesAcquirer.h"

// forward declarations
namespace edm {

  class SubProcessParentageHelper;

  namespace one {

    class OutputModuleBase : public core::OutputModuleCore {
    public:
      template <typename U>
      friend class edm::maker::ModuleHolderT;
      template <typename T>
      friend class ::edm::WorkerT;
      template <typename T>
      friend class ::edm::OutputModuleCommunicatorT;
      typedef OutputModuleBase ModuleType;

      explicit OutputModuleBase(ParameterSet const& pset);

      OutputModuleBase(OutputModuleBase const&) = delete;             // Disallow copying and moving
      OutputModuleBase& operator=(OutputModuleBase const&) = delete;  // Disallow copying and moving

      //Output modules always need writeRun and writeLumi to be called
      virtual bool wantsProcessBlocks() const = 0;
      virtual bool wantsInputProcessBlocks() const = 0;
      virtual bool wantsGlobalRuns() const = 0;
      virtual bool wantsGlobalLuminosityBlocks() const = 0;
      bool wantsStreamRuns() const { return false; }
      bool wantsStreamLuminosityBlocks() const { return false; };

      virtual SerialTaskQueue* globalRunsQueue() { return nullptr; }
      virtual SerialTaskQueue* globalLuminosityBlocksQueue() { return nullptr; }
      SharedResourcesAcquirer& sharedResourcesAcquirer() { return resourcesAcquirer_; }

      SubProcessParentageHelper const* subProcessParentageHelper() const { return subProcessParentageHelper_; }

    protected:
      void doPreallocate(PreallocationConfiguration const&);

      void doBeginJob();
      bool doEvent(EventTransitionInfo const&, ActivityRegistry*, ModuleCallingContext const*);

      void configure(OutputModuleDescription const& desc);

    private:
      SubProcessParentageHelper const* subProcessParentageHelper_;

      SharedResourcesAcquirer resourcesAcquirer_;
      SerialTaskQueue runQueue_;
      SerialTaskQueue luminosityBlockQueue_;

      virtual SharedResourcesAcquirer createAcquirer();

      std::string workerType() const { return "WorkerT<edm::one::OutputModuleBase>"; }

      void registerProductsAndCallbacks(OutputModuleBase const*, ProductRegistry const*) {}

      virtual void preActionBeforeRunEventAsync(WaitingTaskHolder iTask,
                                                ModuleCallingContext const& iModuleCallingContext,
                                                Principal const& iPrincipal) const {}

      bool hasAcquire() const { return false; }
    };
  }  // namespace one
}  // namespace edm
#endif