IAuditor.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2026 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.                                             *
\***********************************************************************************/
#pragma once
 
#include <GaudiKernel/EventContext.h>
#include <GaudiKernel/INamedInterface.h>
#include <GaudiKernel/StatusCode.h>
 
#include <string>
 
namespace Gaudi {

  class GAUDI_API IAuditor : virtual public INamedInterface {
  public:
    DeclareInterfaceID( IAuditor, 1, 0 );

    virtual void before( std::string const& event, std::string const& caller, EventContext const& ) = 0;

    virtual void after( std::string const& event, std::string const& caller, EventContext const&,
                        StatusCode const& sc = StatusCode::SUCCESS ) = 0;

    virtual bool isEnabled() const = 0;

    virtual StatusCode sysInitialize() = 0;

    virtual StatusCode sysFinalize() = 0;
 
    // Defining a set of standard events used internally by the framework
    static const std::string Initialize;
    static const std::string ReInitialize;
    static const std::string Start;
    static const std::string ReStart;
    static const std::string Execute;
    static const std::string Stop;
    static const std::string Finalize;
    // Suspension is not a standard event, but it is used by the AsynchronousAlgorithm to audit suspension of execution
    static const std::string Suspension;
  };
 
} // namespace Gaudi