IAuditor.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2024 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#ifndef GAUDI_IAUDITOR_H
#define GAUDI_IAUDITOR_H
 
// Include files
#include <GaudiKernel/INamedInterface.h>
#include <array>
#include <string>
 
class GAUDI_API IAuditor : virtual public INamedInterface {
public:
  DeclareInterfaceID( IAuditor, 3, 0 );
 
  enum StandardEventType { Initialize, ReInitialize, Execute, Finalize, Start, Stop, ReStart };
  friend const char* toStr( IAuditor::StandardEventType e ) {
    constexpr std::array<const char*, IAuditor::StandardEventType::ReStart + 1> s_tbl = {
        { "Initialize", "ReInitialize", "Execute", "Finalize", "Start", "Stop", "ReStart" } };
    return e <= IAuditor::StandardEventType::ReStart ? s_tbl[e] : nullptr;
  }
  friend std::ostream& operator<<( std::ostream& s, IAuditor::StandardEventType e ) { return s << toStr( e ); }
 
  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::SUCCESS ) = 0;
  virtual void after( StandardEventType, const std::string&, const StatusCode& sc = StatusCode::SUCCESS ) = 0;
 
  virtual void after( CustomEventTypeRef, INamedInterface*, const StatusCode& sc = StatusCode::SUCCESS ) = 0;
  virtual void after( CustomEventTypeRef, const std::string&, const StatusCode& sc = StatusCode::SUCCESS ) = 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 beforeFinalize( INamedInterface* ) = 0;
  virtual void afterFinalize( INamedInterface* ) = 0;
 
  virtual StatusCode sysInitialize() = 0;
 
  virtual StatusCode sysFinalize() = 0;
};
 
#endif // GAUDIKERNEL_IAUDITOR_H