This service manages Auditors. More...

#include </builds/gaudi/Gaudi/GaudiCommonSvc/src/AuditorSvc.h>

Inheritance diagram for AuditorSvc:

[legend]

Collaboration diagram for AuditorSvc:

[legend]

Public Member Functions
StatusCode	initialize () override

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

StatusCode	sysInitialize () override

StatusCode	sysFinalize () override

Gaudi::IAuditor *	getAuditor (std::string const &name) const override
	management functionality: retrieve an Auditor

bool	hasAuditor (std::string const &name) const override
	management functionality: check if an Auditor exists

StatusCode	addAuditor (std::string const &name) override
	adds a new Auditor

std::optional< StatusCode >	removesAuditor (std::string const &name) override
	removes an Auditor. Returns whether the Auditor was present (and thus removed)

Public Member Functions inherited from extends< Service, IAuditorSvc >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service.

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service.

StatusCode	sysStart () override
	Initialize Service.

StatusCode	sysStop () override
	Initialize Service.

StatusCode	sysFinalize () override
	Finalize Service.

StatusCode	sysReinitialize () override
	Re-initialize the Service.

StatusCode	sysRestart () override
	Re-initialize the Service.

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor.

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
	Declare used tool.

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)

Private Member Functions
std::unique_ptr< Gaudi::IAuditor >	newAuditor (MsgStream &, std::string_view)

StatusCode	syncAuditors ()
	internal mathod to update auditors when m_audNameList is changed

Private Attributes
Gaudi::Property< std::vector< std::string > >	m_audNameList

Gaudi::Property< bool >	m_isEnabled { this, "Enable", true, "enable/disable alltogether the auditors" }

std::vector< std::unique_ptr< Gaudi::IAuditor > >	m_pAudList

Additional Inherited Members
Public Types inherited from extends< Service, IAuditorSvc >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory<IService( const std::string&, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

int	outputLevel () const
	get the `Service's` output level

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

Detailed Description

This service manages Auditors.

Auditors can be inserted in the system to audit the Algorithms is in their functions.

Definition at line 22 of file AuditorSvc.h.

Member Function Documentation

◆ addAuditor()

StatusCode AuditorSvc::addAuditor ( std::string const & name )

override

adds a new Auditor

Definition at line 54 of file AuditorSvc.cpp.

                                                         {
  // this is clumsy, but the PropertyHolder won't tell us when my property changes right
  // under my nose, so I'll have to figure this out the hard way
  if ( !hasAuditor( name ) ) { // if auditor does not yet exist
    auto aud = newAuditor( msgStream(), name );
    if ( aud ) {
      m_pAudList.push_back( std::move( aud ) );
    } else {
      error() << "Error constructing Auditor " << name << endmsg;
      return StatusCode::FAILURE;
    }
  }
  return StatusCode::SUCCESS;
}

◆ after()

void AuditorSvc::after	(	std::string const &	evt,
		std::string const &	name,
		EventContext const &	context,
		StatusCode const &	sc )

override

Definition at line 117 of file AuditorSvc.cpp.

                                               {
  if ( !isEnabled() ) return;
  for ( auto& it : m_pAudList ) {
    if ( it->isEnabled() ) it->after( evt, name, context, sc );
  }
}

◆ before()

void AuditorSvc::before	(	std::string const &	evt,
		std::string const &	name,
		EventContext const &	context )

override

Definition at line 110 of file AuditorSvc.cpp.

                                                                                                  {
  if ( !isEnabled() ) return;
  for ( auto& it : m_pAudList ) {
    if ( it->isEnabled() ) it->before( evt, name, context );
  }
}

◆ finalize()

StatusCode AuditorSvc::finalize ( )

override

Definition at line 102 of file AuditorSvc.cpp.

                                {
  for ( auto& it : m_pAudList ) {
    if ( it->isEnabled() ) it->sysFinalize().ignore();
  }
  m_pAudList.clear();
  return Service::finalize();
}

◆ getAuditor()

Gaudi::IAuditor * AuditorSvc::getAuditor ( std::string const & name ) const

override

management functionality: retrieve an Auditor

Definition at line 46 of file AuditorSvc.cpp.

                                                                   {
  // find an auditor by name, return 0 on error
  auto it = std::find_if(
      std::begin( m_pAudList ), std::end( m_pAudList ),
      [item_name = Gaudi::Utils::TypeNameString( name ).name()]( auto const& i ) { return i->name() == item_name; } );
  return it != std::end( m_pAudList ) ? it->get() : nullptr;
}

◆ hasAuditor()

bool AuditorSvc::hasAuditor ( std::string const & name ) const

inlineoverride

management functionality: check if an Auditor exists

Definition at line 41 of file AuditorSvc.h.

41{ return getAuditor( name ) != nullptr; };

AuditorSvc::getAuditor

Gaudi::IAuditor * getAuditor(std::string const &name) const override

management functionality: retrieve an Auditor

Definition AuditorSvc.cpp:46

◆ initialize()

StatusCode AuditorSvc::initialize ( )

inlineoverride

Definition at line 24 of file AuditorSvc.h.

                                   {
    // make sure we synchronize auditors at initialization
    return Service::initialize().andThen( [&] { return syncAuditors(); } );
  }

◆ isEnabled()

bool AuditorSvc::isEnabled ( ) const

inlineoverride

Definition at line 33 of file AuditorSvc.h.

33{ return m_isEnabled; };

AuditorSvc::m_isEnabled

Gaudi::Property< bool > m_isEnabled

Definition AuditorSvc.h:67

◆ newAuditor()

std::unique_ptr< Gaudi::IAuditor > AuditorSvc::newAuditor	(	MsgStream &	log,
		std::string_view	name )

private

Definition at line 25 of file AuditorSvc.cpp.

                                                                                         {
  // locate the auditor factory, instantiate a new auditor, initialize it
  Gaudi::Utils::TypeNameString     item( name );
  std::unique_ptr<Gaudi::IAuditor> aud{
      Gaudi::Auditor::Factory::create( item.type(), item.name(), serviceLocator().get() ) };
  if ( aud ) {
    // make sure we increase the internal reference counter used by SmartIF or any usage of it
    // somewhere else will delete the Auditor in our back !
    // note that release is never called, as we handle the ownership via unique_ptr and do not
    // rely on Gaudi's legacy black magic
    aud->addRef();
    if ( m_targetState >= Gaudi::StateMachine::INITIALIZED && aud->sysInitialize().isFailure() ) {
      log << MSG::WARNING << "Failed to initialize Auditor " << name << endmsg;
      aud.reset();
    }
  } else {
    log << MSG::WARNING << "Unable to retrieve factory for Auditor " << name << endmsg;
  }
  return aud;
}

◆ removesAuditor()

std::optional< StatusCode > AuditorSvc::removesAuditor ( std::string const & name )

override

removes an Auditor. Returns whether the Auditor was present (and thus removed)

Definition at line 69 of file AuditorSvc.cpp.

                                                                          {
  auto it = std::find_if(
      std::begin( m_pAudList ), std::end( m_pAudList ),
      [item_name = Gaudi::Utils::TypeNameString( name ).name()]( auto const& i ) { return i->name() == item_name; } );
  if ( it != std::end( m_pAudList ) ) {
    auto sc = ( *it )->sysFinalize();
    if ( sc.isFailure() ) { error() << "Finalization of auditor " << name << " failed : " << sc << endmsg; }
    m_pAudList.erase( it );
    return sc;
  }
  return {};
}

◆ syncAuditors()

StatusCode AuditorSvc::syncAuditors ( )

private

internal mathod to update auditors when m_audNameList is changed

Definition at line 82 of file AuditorSvc.cpp.

                                    {
  // drop all existing Auditors no more declared (and finalize them in case)
  auto pastEnd = std::remove_if( begin( m_pAudList ), end( m_pAudList ), [this]( auto& entry ) -> bool {
    return std::find( begin( m_audNameList ), end( m_audNameList ), entry->name() ) != m_audNameList.end();
  } );
  std::for_each( pastEnd, m_pAudList.end(), [this]( auto& entry ) {
    if ( entry->isEnabled() ) {
      auto sc = entry->sysFinalize();
      if ( sc.isFailure() ) { error() << "Finalization of auditor " << entry->name() << " failed : " << sc << endmsg; }
    }
  } );
  m_pAudList.erase( pastEnd, m_pAudList.end() );
  // create all newly declared Auditors
  StatusCode sc = StatusCode::SUCCESS;
  for ( auto& it : m_audNameList ) {
    if ( addAuditor( it ).isFailure() ) sc = StatusCode::FAILURE;
  }
  return sc;
}

◆ sysFinalize()

StatusCode AuditorSvc::sysFinalize ( )

inlineoverride

Definition at line 36 of file AuditorSvc.h.

36{ return Service::sysFinalize(); }

Service::sysFinalize

StatusCode sysFinalize() override

Finalize Service.

Definition Service.cpp:193

◆ sysInitialize()

StatusCode AuditorSvc::sysInitialize ( )

inlineoverride

Definition at line 35 of file AuditorSvc.h.

35{ return Service::sysInitialize(); }

Service::sysInitialize

StatusCode sysInitialize() override

Initialize Service.

Definition Service.cpp:33

Member Data Documentation

◆ m_audNameList

Gaudi::Property<std::vector<std::string> > AuditorSvc::m_audNameList

private

Initial value:

{
      this,
      "Auditors",
      {},
      [this]( auto& ) {
        
        
        if ( FSMState() >= Gaudi::StateMachine::INITIALIZED ) {
          error() << "Updating 'Auditors' after initialize is not supported. Use addAuditor instead." << endmsg;
        }
      },
      "list of auditors names",
      "OrderedSet<std::string>" }

Definition at line 54 of file AuditorSvc.h.

                                                   {
      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>" };

◆ m_isEnabled

Gaudi::Property<bool> AuditorSvc::m_isEnabled { this, "Enable", true, "enable/disable alltogether the auditors" }

private

Definition at line 67 of file AuditorSvc.h.

67{ this, "Enable", true, "enable/disable alltogether the auditors" };

◆ m_pAudList

std::vector<std::unique_ptr<Gaudi::IAuditor> > AuditorSvc::m_pAudList

private

Definition at line 70 of file AuditorSvc.h.

The documentation for this class was generated from the following files:

GaudiCommonSvc/src/AuditorSvc.h
GaudiCommonSvc/src/AuditorSvc.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addAuditor()

◆ after()

◆ before()

◆ finalize()

◆ getAuditor()

◆ hasAuditor()

◆ initialize()

◆ isEnabled()

◆ newAuditor()

◆ removesAuditor()

◆ syncAuditors()

◆ sysFinalize()

◆ sysInitialize()

Member Data Documentation

◆ m_audNameList

◆ m_isEnabled

◆ m_pAudList