Base class from which all concrete auditor classes should be derived. More...

#include <GaudiKernel/Auditor.h>

Inheritance diagram for Auditor:

[legend]

Collaboration diagram for Auditor:

[legend]

Public Types
using	Factory = Gaudi::PluginService::Factory< IAuditor (const std::string &, ISvcLocator )>

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

Public Types inherited from CommonMessaging< implements< IAuditor, IProperty > >
using	base_class = CommonMessaging

Public Member Functions
	Auditor (const std::string &name, ISvcLocator *svcloc)
	Constructor. More...

	Auditor (const Auditor &a)=delete

Auditor &	operator= (const Auditor &rhs)=delete

StatusCode	sysInitialize () override
	Initialization method invoked by the framework. More...

StatusCode	sysFinalize () override
	Finalization method invoked by the framework. More...

void	before (StandardEventType, INamedInterface *) override
	The following methods are meant to be implemented by the child class... More...

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

void	beforeInitialize (INamedInterface *) override

void	afterInitialize (INamedInterface *) override

void	beforeReinitialize (INamedInterface *) override

void	afterReinitialize (INamedInterface *) override

void	beforeExecute (INamedInterface *) override

void	afterExecute (INamedInterface *, const StatusCode &) override

void	beforeFinalize (INamedInterface *) override

void	afterFinalize (INamedInterface *) override

virtual StatusCode	initialize ()

virtual StatusCode	finalize ()

const std::string &	name () const override

bool	isEnabled () const override

SmartIF< ISvcLocator > &	serviceLocator () const override
	The standard service locator. More...

template<class T >
StatusCode	service (const std::string &name, T *&svc, bool createIf=false) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T = IService>
SmartIF< T >	service (const std::string &name, bool createIf=false) const

StatusCode	setProperties ()
	Set the auditor's properties. More...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
	PropertyHolder ()=default

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

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. More...

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. More...

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

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p) override
	set the property form another property More...

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

StatusCode	setProperty (const std::string &n, const std::string &v) override
	set the property from name and the value More...

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

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

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

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

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

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

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

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

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

MSG::Level	outputLevel () const
	Backward compatibility function for getting the output level. More...

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

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

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

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

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

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

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

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

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

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

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

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

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

Private Attributes
std::string	m_name
	Auditor's name for identification. More...

SmartIF< ISvcLocator >	m_pSvcLocator
	Pointer to service locator service. More...

Gaudi::Property< int >	m_outputLevel

Gaudi::Property< bool >	m_isEnabled {this, "Enable", true, "should the auditor be used or not"}

bool	m_isInitialized = false
	Auditor has been initialized flag. More...

bool	m_isFinalized = false
	Auditor has been finalized flag. More...

Additional Inherited Members
Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
Gaudi::Details::PropertyBase *	property (const std::string &name) const

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

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

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

Detailed Description

Base class from which all concrete auditor classes should be derived.

The only base class functionality which may be used in the constructor of a concrete auditor is the declaration of member variables as properties. All other functionality, i.e. the use of services, may be used only in initialize() and afterwards.

Author: David Quarrie

Date: 2000

Author: Marco Clemencic

Date: 2008-03

Definition at line 44 of file Auditor.h.

Member Typedef Documentation

◆ Factory

using Auditor::Factory = Gaudi::PluginService::Factory<IAuditor*( const std::string&, ISvcLocator* )>

Definition at line 46 of file Auditor.h.

Constructor & Destructor Documentation

◆ Auditor() [1/2]

Auditor::Auditor	(	const std::string &	name,
		ISvcLocator *	svcloc
	)

Constructor.

Parameters

name	The algorithm object's name
svcloc	A pointer to a service location service

Definition at line 22 of file Auditor.cpp.

22 : m_name( name ), m_pSvcLocator( pSvcLocator ) {}

Auditor::m_name

std::string m_name

Auditor's name for identification.

Definition: Auditor.h:133

Auditor::m_pSvcLocator

SmartIF< ISvcLocator > m_pSvcLocator

Pointer to service locator service.

Definition: Auditor.h:135

Auditor::name

const std::string & name() const override

Definition: Auditor.cpp:187

◆ Auditor() [2/2]

Auditor::Auditor ( const Auditor & a )

delete

Member Function Documentation

◆ after() [1/4]

void Auditor::after	(	StandardEventType	evt,
		INamedInterface *	obj,
		const StatusCode &	sc
	)

override

Definition at line 107 of file Auditor.cpp.

                                                                                        {
   switch ( evt ) {
   case Initialize:
     afterInitialize( obj );
     break;
   case ReInitialize:
     afterReinitialize( obj );
     break;
   case Execute:
     afterExecute( obj, sc );
     break;
   case Finalize:
     afterFinalize( obj );
     break;
   case Start:
     break;
   case Stop:
     break;
   case ReStart:
     break;
   default:
     break; // do nothing
   }
 }

◆ after() [2/4]

void Auditor::after	(	StandardEventType	,
		const std::string &	,
		const StatusCode &
	)

override

Definition at line 131 of file Auditor.cpp.

131 {}

◆ after() [3/4]

void Auditor::after	(	CustomEventTypeRef	,
		INamedInterface *	,
		const StatusCode &
	)

override

Definition at line 133 of file Auditor.cpp.

133 {}

◆ after() [4/4]

void Auditor::after	(	CustomEventTypeRef	,
		const std::string &	,
		const StatusCode &
	)

override

Definition at line 134 of file Auditor.cpp.

134 {}

◆ afterExecute()

void Auditor::afterExecute	(	INamedInterface *	,
		const StatusCode &
	)

override

Definition at line 141 of file Auditor.cpp.

141 {}

◆ afterFinalize()

void Auditor::afterFinalize ( INamedInterface * )

override

Definition at line 143 of file Auditor.cpp.

143 {}

◆ afterInitialize()

void Auditor::afterInitialize ( INamedInterface * )

override

Definition at line 137 of file Auditor.cpp.

137 {}

◆ afterReinitialize()

void Auditor::afterReinitialize ( INamedInterface * )

override

Definition at line 139 of file Auditor.cpp.

139 {}

◆ before() [1/4]

void Auditor::before	(	StandardEventType	evt,
		INamedInterface *	obj
	)

override

The following methods are meant to be implemented by the child class...

Definition at line 77 of file Auditor.cpp.

                                                                   {
   switch ( evt ) {
   case Initialize:
     beforeInitialize( obj );
     break;
   case ReInitialize:
     beforeReinitialize( obj );
     break;
   case Execute:
     beforeExecute( obj );
     break;
   case Finalize:
     beforeFinalize( obj );
     break;
   case Start:
     break;
   case Stop:
     break;
   case ReStart:
     break;
   default:
     break; // do nothing
   }
 }

◆ before() [2/4]

void Auditor::before	(	StandardEventType	,
		const std::string &
	)

override

Definition at line 101 of file Auditor.cpp.

101 {}

◆ before() [3/4]

void Auditor::before	(	CustomEventTypeRef	,
		INamedInterface *
	)

override

Definition at line 103 of file Auditor.cpp.

103 {}

◆ before() [4/4]

void Auditor::before	(	CustomEventTypeRef	,
		const std::string &
	)

override

Definition at line 104 of file Auditor.cpp.

104 {}

◆ beforeExecute()

void Auditor::beforeExecute ( INamedInterface * )

override

Definition at line 140 of file Auditor.cpp.

140 {}

◆ beforeFinalize()

void Auditor::beforeFinalize ( INamedInterface * )

override

Definition at line 142 of file Auditor.cpp.

142 {}

◆ beforeInitialize()

void Auditor::beforeInitialize ( INamedInterface * )

override

Definition at line 136 of file Auditor.cpp.

136 {}

◆ beforeReinitialize()

void Auditor::beforeReinitialize ( INamedInterface * )

override

Definition at line 138 of file Auditor.cpp.

138 {}

◆ finalize()

StatusCode Auditor::finalize ( )

virtual

Reimplemented in PerfMonAuditor, Google::AuditorBase, TimingAuditor, and AlgContextAuditor.

Definition at line 185 of file Auditor.cpp.

185 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

constexpr static const auto SUCCESS

Definition: StatusCode.h:96

◆ initialize()

StatusCode Auditor::initialize ( )

virtual

Reimplemented in Google::HeapChecker, PerfMonAuditor, TimingAuditor, Google::AuditorBase, AlgContextAuditor, IntelProfilerAuditor, MemStatAuditor, and ChronoAuditor.

Definition at line 74 of file Auditor.cpp.

74 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

constexpr static const auto SUCCESS

Definition: StatusCode.h:96

◆ isEnabled()

bool Auditor::isEnabled ( ) const

override

Definition at line 189 of file Auditor.cpp.

189 { return m_isEnabled; }

Auditor::m_isEnabled

Gaudi::Property< bool > m_isEnabled

Definition: Auditor.h:141

◆ name()

const std::string & Auditor::name ( ) const

override

Definition at line 187 of file Auditor.cpp.

187 { return m_name; }

Auditor::m_name

std::string m_name

Auditor's name for identification.

Definition: Auditor.h:133

◆ operator=()

Auditor& Auditor::operator= ( const Auditor & rhs )

delete

◆ service() [1/2]

template<class T >

StatusCode Auditor::service	(	const std::string &	name,
		T *&	svc,
		bool	createIf = `false`
	)		const

inline

Access a service by name, creating it if it doesn't already exist.

Definition at line 109 of file Auditor.h.

                                                                                     {
     auto ptr = serviceLocator()->service<T>( name, createIf );
     if ( ptr ) {
       svc = ptr.get();
       svc->addRef();
       return StatusCode::SUCCESS;
     }
     svc = nullptr;
     return StatusCode::FAILURE;
   }

◆ service() [2/2]

template<class T = IService>

SmartIF<T> Auditor::service	(	const std::string &	name,
		bool	createIf = `false`
	)		const

inline

Definition at line 121 of file Auditor.h.

                                                                            {
     return serviceLocator()->service<T>( name, createIf );
   }

◆ serviceLocator()

SmartIF< ISvcLocator > & Auditor::serviceLocator ( ) const

override

The standard service locator.

Returns a pointer to the service locator service. This service may be used by an auditor to request any services it requires in addition to those provided by default.

Definition at line 191 of file Auditor.cpp.

191 { return m_pSvcLocator; }

Auditor::m_pSvcLocator

SmartIF< ISvcLocator > m_pSvcLocator

Pointer to service locator service.

Definition: Auditor.h:135

◆ setProperties()

StatusCode Auditor::setProperties ( )

Set the auditor's properties.

This method requests the job options service to set the values of any declared properties. The method is invoked from within sysInitialize() by the framework and does not need to be explicitly called by a concrete auditor.

Definition at line 194 of file Auditor.cpp.

                                   {
   if ( !m_pSvcLocator ) return StatusCode::FAILURE;
   auto jos = service<IJobOptionsSvc>( "JobOptionsSvc" );
   if ( !jos ) return StatusCode::FAILURE;
 
   // this initializes the messaging, in case property update handlers need to print
   // and update the property value bypassing the update handler
   m_outputLevel.value() = setUpMessaging();
 
   return jos->setMyProperties( name(), this );
 }

◆ sysFinalize()

StatusCode Auditor::sysFinalize ( )

override

Finalization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself.

RETURN !!!

catch GaudiExeption

(1) perform the printout of message

(2) print the exception itself (NB! - GaudiException is a linked list of all "previous exceptions")

catch std::exception

(1) perform the printout of message

(2) print the exception itself

catch unknown exception

(1) perform the printout

Definition at line 145 of file Auditor.cpp.

                                 {
   StatusCode sc = StatusCode::SUCCESS;
   try {
     //
     // Invoke the finalize() method of the derived class if
     // it has been initialized.
     if ( m_isInitialized && !m_isFinalized ) {
       m_isFinalized = true;
       sc            = finalize();
       if ( !sc.isSuccess() ) return StatusCode::FAILURE;
     }
     return sc; 
     //
   } catch ( const GaudiException& Exception ) 
   {
     MsgStream log( msgSvc(), name() + ".sysFinalize()" );
     log << MSG::FATAL << " Exception with tag=" << Exception.tag() << " is catched " << endmsg;
     MsgStream logEx( msgSvc(), Exception.tag() );
     logEx << MSG::ERROR << Exception << endmsg;
   } catch ( const std::exception& Exception ) 
   {
     MsgStream log( msgSvc(), name() + ".sysFinalize()" );
     log << MSG::FATAL << " Standard std::exception is caught " << endmsg;
     MsgStream logEx( msgSvc(), name() + "*std::exception*" );
     logEx << MSG::ERROR << Exception.what() << endmsg;
   } catch ( ... ) 
   {
     MsgStream log( msgSvc(), name() + ".sysFinalize()" );
     log << MSG::FATAL << " UNKNOWN Exception is caught " << endmsg;
   }
   return StatusCode::FAILURE;
 }

◆ sysInitialize()

StatusCode Auditor::sysInitialize ( )

override

Initialization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself.

RETURN !!!

catch Gaudi Exception

(1) perform the printout of message

(2) print the exception itself (NB! - GaudiException is a linked list of all "previous exceptions")

catch std::exception

(1) perform the printout of message

(2) print the exception itself (NB! - GaudiException is a linked list of all "previous exceptions")

(1) perform the printout

Definition at line 25 of file Auditor.cpp.

                                   {
   StatusCode sc;
 
   // Bypass the initialization if the auditor is disabled or
   // has already been initialized.
   if ( isEnabled() && !m_isInitialized ) {
 
     // Setup the default service ... this should be upgraded so as to be configurable.
     if ( !m_pSvcLocator ) return StatusCode::FAILURE;
 
     // Set the Auditor's properties
     sc = setProperties();
     if ( !sc.isSuccess() ) return StatusCode::FAILURE;
 
     {
       try {
         // Invoke the initialize() method of the derived class
         sc = initialize();
         if ( !sc.isSuccess() ) return StatusCode::FAILURE;
         m_isInitialized = true;
 
         return sc;                                
       } catch ( const GaudiException& Exception ) 
       {
         MsgStream log( msgSvc(), name() + ".sysInitialize()" );
         log << MSG::FATAL << " Exception with tag=" << Exception.tag() << " is caught " << endmsg;
         MsgStream logEx( msgSvc(), Exception.tag() );
         logEx << MSG::ERROR << Exception << endmsg;
       } catch ( const std::exception& Exception ) 
       {
         MsgStream log( msgSvc(), name() + ".sysInitialize()" );
         log << MSG::FATAL << " Standard std::exception is caught " << endmsg;
         MsgStream logEx( msgSvc(), name() + "*std::exception*" );
         logEx << MSG::ERROR << Exception.what() << endmsg;
       } catch ( ... ) {
         MsgStream log( msgSvc(), name() + ".sysInitialize()" );
         log << MSG::FATAL << " UNKNOWN Exception is  caught " << endmsg;
       }
     }
   }
   return StatusCode::FAILURE;
 }

Member Data Documentation

◆ m_isEnabled

Gaudi::Property<bool> Auditor::m_isEnabled {this, "Enable", true, "should the auditor be used or not"}

private

Definition at line 141 of file Auditor.h.

◆ m_isFinalized

bool Auditor::m_isFinalized = false

private

Auditor has been finalized flag.

Definition at line 144 of file Auditor.h.

◆ m_isInitialized

bool Auditor::m_isInitialized = false

private

Auditor has been initialized flag.

Definition at line 143 of file Auditor.h.

◆ m_name

std::string Auditor::m_name

private

Auditor's name for identification.

Definition at line 133 of file Auditor.h.

◆ m_outputLevel

Gaudi::Property<int> Auditor::m_outputLevel

private

Initial value:

{
      this, "OutputLevel", MSG::NIL,
      [this]( Gaudi::Details::PropertyBase& ) { this->updateMsgStreamOutputLevel( this->m_outputLevel ); },
      "output level"}

Definition at line 137 of file Auditor.h.

◆ m_pSvcLocator

SmartIF<ISvcLocator> Auditor::m_pSvcLocator

mutableprivate

Pointer to service locator service.

Definition at line 135 of file Auditor.h.

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

GaudiKernel/GaudiKernel/Auditor.h
GaudiKernel/src/Lib/Auditor.cpp

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Factory

Constructor & Destructor Documentation

◆ Auditor() [1/2]

◆ Auditor() [2/2]

Member Function Documentation

◆ after() [1/4]

◆ after() [2/4]

◆ after() [3/4]

◆ after() [4/4]

◆ afterExecute()

◆ afterFinalize()

◆ afterInitialize()

◆ afterReinitialize()

◆ before() [1/4]

◆ before() [2/4]

◆ before() [3/4]

◆ before() [4/4]

◆ beforeExecute()

◆ beforeFinalize()

◆ beforeInitialize()

◆ beforeReinitialize()

◆ finalize()

◆ initialize()

◆ isEnabled()

◆ name()

◆ operator=()

◆ service() [1/2]

◆ service() [2/2]

◆ serviceLocator()

◆ setProperties()

◆ sysFinalize()

◆ sysInitialize()

Member Data Documentation

◆ m_isEnabled

◆ m_isFinalized

◆ m_isInitialized

◆ m_name

◆ m_outputLevel

◆ m_pSvcLocator