IEventProcessor.h

Go to the documentation of this file.

#ifndef FWCore_Framework_IEventProcessor_h
#define FWCore_Framework_IEventProcessor_h

/*
Abstract base class for Event Processors

Original Authors: W. David Dagenhart, Marc Paterno
*/

#include "DataFormats/Provenance/interface/ProcessHistoryID.h"
#include "DataFormats/Provenance/interface/RunID.h"
#include "DataFormats/Provenance/interface/LuminosityBlockID.h"


#include <string>

namespace statemachine {
  class Restart;
  class Run;
}

namespace edm {
  class IEventProcessor {
  public:

    // Status codes:
    //   0     successful completion
    //   1     exception of unknown type caught
    //   2     everything else
    //   3     signal received
    //   4     input complete
    //   5     call timed out
    //   6     input count complete
    enum Status { epSuccess=0, epException=1, epOther=2, epSignal=3,
                  epInputComplete=4, epTimedOut=5, epCountComplete=6 };

    // Eventually, we might replace StatusCode with a class. This
    // class should have an automatic conversion to 'int'.
    typedef Status StatusCode ;

    virtual ~IEventProcessor();

    virtual StatusCode runToCompletion() = 0;

    virtual void readFile() = 0;
    virtual void closeInputFile(bool cleaningUpAfterException) = 0;
    virtual void openOutputFiles() = 0;
    virtual void closeOutputFiles() = 0;

    virtual void respondToOpenInputFile() = 0;
    virtual void respondToCloseInputFile() = 0;

    virtual void startingNewLoop() = 0;
    virtual bool endOfLoop() = 0;
    virtual void rewindInput() = 0;
    virtual void prepareForNextLoop() = 0;
    virtual bool shouldWeCloseOutput() const = 0;

    virtual void doErrorStuff() = 0;

    virtual void beginRun(statemachine::Run const& run) = 0;
    virtual void endRun(statemachine::Run const& run, bool cleaningUpAfterException) = 0;

    virtual void beginLumi(ProcessHistoryID const& phid, RunNumber_t run, LuminosityBlockNumber_t lumi) = 0;
    virtual void endLumi(ProcessHistoryID const& phid, RunNumber_t run, LuminosityBlockNumber_t lumi, bool cleaningUpAfterException) = 0;

    virtual statemachine::Run readRun() = 0;
    virtual statemachine::Run readAndMergeRun() = 0;
    virtual int readLuminosityBlock() = 0;
    virtual int readAndMergeLumi() = 0;
    virtual void writeRun(statemachine::Run const& run) = 0;
    virtual void deleteRunFromCache(statemachine::Run const& run) = 0;
    virtual void writeLumi(ProcessHistoryID const& phid, RunNumber_t run, LuminosityBlockNumber_t lumi) = 0;
    virtual void deleteLumiFromCache(ProcessHistoryID const& phid,RunNumber_t run, LuminosityBlockNumber_t lumi) = 0;

    virtual void readAndProcessEvent() = 0;
    virtual bool shouldWeStop() const = 0;

    virtual void setExceptionMessageFiles(std::string& message) = 0;
    virtual void setExceptionMessageRuns(std::string& message) = 0;
    virtual void setExceptionMessageLumis(std::string& message) = 0;

    virtual bool alreadyHandlingException() const = 0;
  };
}

#endif