In This Package:

IAuditor.h

Go to the documentation of this file.

// $Header: /local/reps/Gaudi/GaudiKernel/GaudiKernel/IAuditor.h,v 1.11 2008/10/27 19:22:20 marcocle Exp $
#ifndef GAUDI_IAUDITOR_H
#define GAUDI_IAUDITOR_H

// Include files
#include "GaudiKernel/INamedInterface.h"
#include <string>

// Declaration of the interface ID ( interface id, major version, minor version)
static const InterfaceID IID_IAuditor(18, 2 , 0);

class IAuditor : virtual public INamedInterface {
 public:

  static const InterfaceID& interfaceID() { return IID_IAuditor; }

  enum StandardEventType {
    Initialize,
    ReInitialize,
    Execute,
    BeginRun,
    EndRun,
    Finalize,
    Start,
    Stop,
    ReStart
  };

  typedef std::string CustomEventType;
  typedef const CustomEventType& CustomEventTypeRef;

  virtual void before(StandardEventType, INamedInterface*) = 0;
  virtual void before(StandardEventType, const std::string&) = 0;

  virtual void before(CustomEventTypeRef, INamedInterface*) = 0;
  virtual void before(CustomEventTypeRef, const std::string&) = 0;

  virtual void after(StandardEventType, INamedInterface*, const StatusCode& sc = StatusCode(StatusCode::SUCCESS,true)) = 0;
  virtual void after(StandardEventType, const std::string&, const StatusCode& sc = StatusCode(StatusCode::SUCCESS,true)) = 0;

  virtual void after(CustomEventTypeRef, INamedInterface*, const StatusCode& sc = StatusCode(StatusCode::SUCCESS,true)) = 0;
  virtual void after(CustomEventTypeRef, const std::string&, const StatusCode& sc = StatusCode(StatusCode::SUCCESS,true)) = 0;

  virtual bool isEnabled() const = 0;

// ------- Obsolete interface ------
  virtual void beforeInitialize(INamedInterface* ) = 0;
  virtual void afterInitialize(INamedInterface* ) = 0;

  virtual void beforeReinitialize(INamedInterface* ) = 0;
  virtual void afterReinitialize(INamedInterface* ) = 0;

  virtual void beforeExecute(INamedInterface* ) = 0;
  virtual void afterExecute(INamedInterface*, const StatusCode& ) = 0;

  virtual void beforeBeginRun(INamedInterface* ) = 0;
  virtual void afterBeginRun(INamedInterface* ) = 0;

  virtual void beforeEndRun(INamedInterface* ) = 0;
  virtual void afterEndRun(INamedInterface* ) = 0;

  virtual void beforeFinalize(INamedInterface* ) = 0;
  virtual void afterFinalize(INamedInterface* ) = 0;

  virtual StatusCode sysInitialize( ) = 0;

  virtual StatusCode sysFinalize( ) = 0;

};

inline std::ostream & operator << (std::ostream & s, IAuditor::StandardEventType e) {
  switch (e) {
    case IAuditor::Initialize   : return s << "Initialize";
    case IAuditor::ReInitialize : return s << "ReInitialize";
    case IAuditor::Execute      : return s << "Execute";
    case IAuditor::BeginRun     : return s << "BeginRun";
    case IAuditor::EndRun       : return s << "EndRun";
    case IAuditor::Finalize     : return s << "Finalize";
    case IAuditor::Start        : return s << "Start";
    case IAuditor::Stop         : return s << "Stop";
    case IAuditor::ReStart      : return s << "ReStart";
  }
  return s; // cannot be reached, but make the compiler happy
}
#endif // GAUDIKERNEL_IAUDITOR_H

---