ChronoAuditor Class Reference

Monitors the cpu time usage of each algorithm. More...

#include <src/ChronoAuditor.h>

Inheritance diagram for ChronoAuditor:

Collaboration diagram for ChronoAuditor:

Public Member Functions
	ChronoAuditor (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~ChronoAuditor ()
virtual StatusCode	initialize ()
Public Member Functions inherited from CommonAuditor
	CommonAuditor (const std::string &name, ISvcLocator *svcloc)
	Constructor. More...
virtual	~CommonAuditor ()=default
	Destructor. More...
virtual void	before (StandardEventType evt, const std::string &caller)
virtual void	before (StandardEventType evt, INamedInterface *caller)
virtual void	before (CustomEventTypeRef evt, const std::string &caller)
virtual void	before (CustomEventTypeRef evt, INamedInterface *caller)
virtual void	after (StandardEventType evt, const std::string &caller, const StatusCode &sc)
virtual void	after (StandardEventType evt, INamedInterface *caller, const StatusCode &sc)
virtual void	after (CustomEventTypeRef evt, const std::string &caller, const StatusCode &sc)
virtual void	after (CustomEventTypeRef evt, INamedInterface *caller, const StatusCode &sc)
Public Member Functions inherited from Auditor
	Auditor (const std::string &name, ISvcLocator *svcloc)
	Constructor. More...
	~Auditor () override=default
	Destructor. More...
StatusCode	sysInitialize ()
	Initialization method invoked by the framework. More...
StatusCode	sysFinalize ()
	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
void	beforeBeginRun (INamedInterface *) override
void	afterBeginRun (INamedInterface *) override
void	beforeEndRun (INamedInterface *) override
void	afterEndRun (INamedInterface *) override
virtual StatusCode	finalize ()
const std::string &	name () const override
bool	isEnabled () const override
SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...
int	outputLevel () const
	Retrieve the output level of current auditor. More...
void	setOutputLevel (int level)
	Set the output level for current auditor. More...
SmartIF< ISvcLocator > &	serviceLocator () const
	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	setProperty (const Property &p) override
	Set a value of a property of an auditor. More...
StatusCode	setProperty (const std::string &s) override
	Implementation of IProperty::setProperty. More...
StatusCode	setProperty (const std::string &n, const std::string &v) override
	Implementation of IProperty::setProperty. More...
StatusCode	getProperty (Property *p) const override
	Get the value of a property. More...
const Property &	getProperty (const std::string &name) const override
	Get the property by name. More...
StatusCode	getProperty (const std::string &n, std::string &v) const override
	Implementation of IProperty::getProperty. More...
const std::vector< Property * > &	getProperties () const
	Get all properties. More...
bool	hasProperty (const std::string &name) const override
	Implementation of IProperty::hasProperty. More...
template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
StatusCode	setProperties ()
	Set the auditor's properties. More...
template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...
	Auditor (const std::string &name, ISvcLocator *svcloc)
	Constructor. More...
	~Auditor () override=default
	Destructor. More...
StatusCode	sysInitialize ()
	Initialization method invoked by the framework. More...
StatusCode	sysFinalize ()
	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
void	beforeBeginRun (INamedInterface *) override
void	afterBeginRun (INamedInterface *) override
void	beforeEndRun (INamedInterface *) override
void	afterEndRun (INamedInterface *) override
virtual StatusCode	finalize ()
const std::string &	name () const override
bool	isEnabled () const override
SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...
int	outputLevel () const
	Retrieve the output level of current auditor. More...
void	setOutputLevel (int level)
	Set the output level for current auditor. More...
SmartIF< ISvcLocator > &	serviceLocator () const
	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	setProperty (const Property &p) override
	Set a value of a property of an auditor. More...
StatusCode	setProperty (const std::string &s) override
	Implementation of IProperty::setProperty. More...
StatusCode	setProperty (const std::string &n, const std::string &v) override
	Implementation of IProperty::setProperty. More...
StatusCode	getProperty (Property *p) const override
	Get the value of a property. More...
const Property &	getProperty (const std::string &name) const override
	Get the property by name. More...
StatusCode	getProperty (const std::string &n, std::string &v) const override
	Implementation of IProperty::getProperty. More...
const std::vector< Property * > &	getProperties () const
	Get all properties. More...
bool	hasProperty (const std::string &name) const override
	Implementation of IProperty::hasProperty. More...
template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
StatusCode	setProperties ()
	Set the auditor's properties. More...
template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...
Public Member Functions inherited from implements< Interfaces >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	implements ()=default
	Default constructor. More...
	implements (const implements &)
	Copy constructor (zero the reference count) More...
implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...
	~implements () override=default
	Virtual destructor. More...
unsigned long	addRef () override
	Reference Interface instance. More...
unsigned long	release () override
	Release Interface instance. More...
unsigned long	refCount () const override
	Current reference count. More...
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	implements ()=default
	Default constructor. More...
	implements (const implements &)
	Copy constructor (zero the reference count) More...
implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...
	~implements () override=default
	Virtual destructor. More...
unsigned long	addRef () override
	Reference Interface instance. More...
unsigned long	release () override
	Release Interface instance. More...
unsigned long	refCount () const override
	Current reference count. More...
Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Member Functions
virtual void	i_before (CustomEventTypeRef evt, const std::string &caller)
	Default (catch-all) "before" Auditor hook. More...
virtual void	i_after (CustomEventTypeRef evt, const std::string &caller, const StatusCode &sc)
	Default (catch-all) "after" Auditor hook. More...
std::string	i_id (CustomEventTypeRef evt, const std::string &caller)
	Compute the id string to be used for the chrono entity. More...
SmartIF< IChronoStatSvc > &	chronoSvc ()

Private Attributes
SmartIF< IChronoStatSvc >	m_chronoSvc

Additional Inherited Members
Public Types inherited from Auditor
typedef Gaudi::PluginService::Factory< IAuditor *, const std::string &, ISvcLocator * >	Factory
typedef Gaudi::PluginService::Factory< IAuditor *, const std::string &, ISvcLocator * >	Factory
Public Types inherited from implements< Interfaces >
using	base_class = implements< Interfaces...>
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
using	iids = typename extend_interfaces_base::ext_iids
using	base_class = implements< Interfaces...>
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
using	iids = typename extend_interfaces_base::ext_iids
Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...
Protected Member Functions inherited from CommonAuditor
bool	i_auditEventType (const std::string &evt)
	Check if we are requested to audit the passed event type. More...
void	i_updateCustomTypes (Property &)
	Update handler for the obsolete property CustomEventTypes. More...
Protected Attributes inherited from CommonAuditor
StringArrayProperty	m_types
StringArrayProperty	m_customTypes
Protected Attributes inherited from implements< Interfaces >
unsigned long	m_refCount = 0
	Reference counter. More...

Detailed Description

Monitors the cpu time usage of each algorithm.

Author

David Quarrie

Marco Clemencic

Definition at line 14 of file ChronoAuditor.h.

Constructor & Destructor Documentation

ChronoAuditor::ChronoAuditor	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Definition at line 14 of file ChronoAuditor.cpp.

: CommonAuditor(name, pSvcLocator) {
}

ChronoAuditor::~ChronoAuditor ( )

virtual

Definition at line 18 of file ChronoAuditor.cpp.

{}

Member Function Documentation

SmartIF<IChronoStatSvc>& ChronoAuditor::chronoSvc ( )

inlineprivate

Definition at line 34 of file ChronoAuditor.h.

{ return m_chronoSvc; }

void ChronoAuditor::i_after ( CustomEventTypeRef  evt, const std::string &  caller, const StatusCode &  sc  )

privatevirtual

Default (catch-all) "after" Auditor hook.

Implements CommonAuditor.

Definition at line 38 of file ChronoAuditor.cpp.

{
  chronoSvc()->chronoStop(i_id(evt, caller));
}

void ChronoAuditor::i_before ( CustomEventTypeRef  evt, const std::string &  caller  )

privatevirtual

Default (catch-all) "before" Auditor hook.

Implements CommonAuditor.

Definition at line 33 of file ChronoAuditor.cpp.

{
  chronoSvc()->chronoStart(i_id(evt, caller));
}

std::string ChronoAuditor::i_id ( CustomEventTypeRef  evt, const std::string &  caller  )

inlineprivate

Compute the id string to be used for the chrono entity.

Definition at line 30 of file ChronoAuditor.h.

                                                                         {
    return caller + ":" + evt;
  }

StatusCode ChronoAuditor::initialize ( )

virtual

Reimplemented from Auditor.

Definition at line 20 of file ChronoAuditor.cpp.

                                     {
  StatusCode sc = CommonAuditor::initialize();
  if (UNLIKELY(sc.isFailure())) return sc;

  m_chronoSvc = serviceLocator()->service("ChronoStatSvc");
  if (UNLIKELY(!m_chronoSvc.get())) {
    MsgStream log(msgSvc(), name());
    log << MSG::ERROR << "Cannot get ChronoStatSvc" << endmsg;
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

Member Data Documentation

SmartIF<IChronoStatSvc> ChronoAuditor::m_chronoSvc

private

Definition at line 35 of file ChronoAuditor.h.

---

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

• GaudiAud/src/ChronoAuditor.h
• GaudiAud/src/ChronoAuditor.cpp