AuditorSvc.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 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/IAuditorSvc.h>
#include <GaudiKernel/Service.h>
#include <memory>
#include <vector>

class AuditorSvc : public extends<Service, IAuditorSvc> {
public:
  StatusCode initialize() override {
    // make sure we synchronize auditors at initialization
    return Service::initialize().andThen( [&] { return syncAuditors(); } );
  }
  StatusCode finalize() override;
 
  void before( std::string const&, std::string const&, EventContext const& ) override;
  void after( std::string const&, std::string const&, EventContext const&, StatusCode const& ) override;
 
  bool isEnabled() const override { return m_isEnabled; };
 
  StatusCode sysInitialize() override { return Service::sysInitialize(); }
  StatusCode sysFinalize() override { return Service::sysFinalize(); }

  Gaudi::IAuditor* getAuditor( std::string const& name ) const override;
  bool hasAuditor( std::string const& name ) const override { return getAuditor( name ) != nullptr; };
  StatusCode addAuditor( std::string const& name ) override;
  std::optional<StatusCode> removesAuditor( std::string const& name ) override;
 
  using extends::extends;
 
private:
  std::unique_ptr<Gaudi::IAuditor> newAuditor( MsgStream&, std::string_view );
  StatusCode syncAuditors();
 
  Gaudi::Property<std::vector<std::string>> m_audNameList{
      this,
      "Auditors",
      {},
      [this]( auto& ) {
        // Warn that any change of this property after initialize
        // won't be taken into account
        if ( FSMState() >= Gaudi::StateMachine::INITIALIZED ) {
          error() << "Updating 'Auditors' after initialize is not supported. Use addAuditor instead." << endmsg;
        }
      },
      "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<std::unique_ptr<Gaudi::IAuditor>> m_pAudList;
};