OutputWorker.h

Go to the documentation of this file.

#ifndef art_Framework_Core_OutputWorker_h
#define art_Framework_Core_OutputWorker_h
// vim: set sw=2 expandtab :

//  The OutputModule as the schedule sees it.  The job of this object
//  is to call the output module.
//
//  According to our current definition, a single output module can
//  only appear in one worker.

#include "art/Framework/Core/OutputFileGranularity.h"
#include "art/Framework/Core/OutputFileStatus.h"
#include "art/Framework/Core/WorkerT.h"
#include "art/Framework/Core/fwd.h"
#include "art/Framework/Principal/fwd.h"
#include "art/Framework/Services/FileServiceInterfaces/CatalogInterface.h"
#include "art/Framework/Services/Registry/ServiceHandle.h"
#include "art/Persistency/Provenance/fwd.h"
#include "canvas/Persistency/Provenance/fwd.h"

#include <memory>

namespace art {
  struct OutputModuleDescription;
  class OutputWorker : public Worker {
  public:
    virtual ~OutputWorker();
    OutputWorker(OutputModule* mod, WorkerParams const&);

    std::string const& lastClosedFileName() const;
    void closeFile();
    bool fileIsOpen() const;
    void incrementInputFileNumber();
    bool requestsToCloseFile() const;
    void openFile(FileBlock const& fb);
    void writeRun(RunPrincipal& rp);
    void writeSubRun(SubRunPrincipal& srp);
    void writeEvent(EventPrincipal& ep, PathContext const& pc);
    void setRunAuxiliaryRangeSetID(RangeSet const&);
    void setSubRunAuxiliaryRangeSetID(RangeSet const&);
    void setFileStatus(OutputFileStatus);
    Granularity fileGranularity() const;
    void selectProducts(ProductTables const&);

  private:
    hep::concurrency::SerialTaskQueueChain* doSerialTaskQueueChain()
      const override;
    void doBeginJob(detail::SharedResources const&) override;
    void doEndJob() override;
    void doRespondToOpenInputFile(FileBlock const&) override;
    void doRespondToCloseInputFile(FileBlock const&) override;
    void doRespondToOpenOutputFiles(FileBlock const&) override;
    void doRespondToCloseOutputFiles(FileBlock const&) override;
    void doBegin(RunPrincipal&, ModuleContext const&) override;
    void doEnd(RunPrincipal&, ModuleContext const&) override;
    void doBegin(SubRunPrincipal&, ModuleContext const&) override;
    void doEnd(SubRunPrincipal&, ModuleContext const&) override;
    bool doProcess(EventPrincipal&, ModuleContext const&) override;

    // A module is co-owned by one worker per schedule.  Only
    // replicated modules have a one-to-one correspondence with their
    // worker.
    cet::exempt_ptr<OutputModule> module_;
    ServiceHandle<CatalogInterface> ci_{};
    ActivityRegistry const& actReg_;
    Granularity fileGranularity_{Granularity::Unset};
  };
} // namespace art

#endif /* art_Framework_Core_OutputWorker_h */

// Local Variables:
// mode: c++
// End: