AuditorSvc.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 AuditorSvc_AuditorSvc_H
#define AuditorSvc_AuditorSvc_H
 
// Include Files
#include <GaudiKernel/IAuditorSvc.h>
#include <GaudiKernel/Service.h>
#include <list>
#include <vector>
 
//------------------------------------------------------------------
//
// ClassName:   AuditorSvc
//
// Description: This service manages Auditors.
//              Auditors can be inserted in the system to audit the Algorithms is
//              in their functions.
//------------------------------------------------------------------
class AuditorSvc : public extends<Service, IAuditorSvc> {
public:
  // Inherited Service overrides:
  //
  // Initialize the service.
  StatusCode initialize() override;
 
  // Finalize the service.
  StatusCode finalize() override;
 
  // IAuditorSvc interfaces overwrite
  //
 
  void before( StandardEventType, INamedInterface* ) override;
  void before( StandardEventType, const std::string& ) override;
 
  void before( CustomEventTypeRef, INamedInterface* ) override;
  void before( CustomEventTypeRef, const std::string& ) override;
 
  void after( StandardEventType, INamedInterface*, const StatusCode& ) override;
  void after( StandardEventType, const std::string&, const StatusCode& ) override;
 
  void after( CustomEventTypeRef, INamedInterface*, const StatusCode& ) override;
  void after( CustomEventTypeRef, const std::string&, const StatusCode& ) override;
 
  // inform Auditors that the initialize() is about to be called
  void beforeInitialize( INamedInterface* ini ) override;
  // inform Auditors that the initialize() has been called
  void afterInitialize( INamedInterface* ini ) override;
 
  // inform Auditors that the reinitialize() is about to be called
  void beforeReinitialize( INamedInterface* ini ) override;
  // inform Auditors that the reinitialize() has been called
  void afterReinitialize( INamedInterface* ini ) override;
 
  // inform Auditors that the execute() is about to be called
  void beforeExecute( INamedInterface* ini ) override;
  // inform Auditors that the execute() has been called
  void afterExecute( INamedInterface* ini, const StatusCode& ) override;
 
  // inform Auditors that the finalize() is about to be called
  void beforeFinalize( INamedInterface* ini ) override;
  // inform Auditors that the finalize() has been called
  void afterFinalize( INamedInterface* ini ) override;
 
  bool isEnabled() const override;
 
  StatusCode sysInitialize() override;
  StatusCode sysFinalize() override;
 
  // management functionality: retrieve an Auditor
  IAuditor* getAuditor( const std::string& name ) override;
 
  using extends::extends;
 
private:
  // management helper
  SmartIF<IAuditor> newAuditor_( MsgStream&, std::string_view );
  SmartIF<IAuditor> findAuditor_( std::string_view );
  StatusCode        syncAuditors_();
 
  Gaudi::Property<std::vector<std::string>> m_audNameList{
      this, "Auditors", {}, "list of auditors names", "OrderedSet<std::string>" };
  Gaudi::Property<bool> m_isEnabled{ this, "Enable", true, "enable/disable alltogether the auditors" };
 
  // Manager list of Auditors
  std::vector<SmartIF<IAuditor>> m_pAudList;
};
 
#endif