Gaudi Framework, version v24r2

Home   Generated: Wed Dec 4 2013
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ChronoAuditor Class Reference

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

#include <ChronoAuditor.h>

Inheritance diagram for ChronoAuditor:
Inheritance graph
[legend]
Collaboration diagram for ChronoAuditor:
Collaboration graph
[legend]

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.
 
virtual ~CommonAuditor ()
 Destructor.
 
virtual void before (StandardEventType evt, const std::string &caller)
 
virtual void before (StandardEventType evt, INamedInterface *caller)
 The following methods are meant to be implemented by the child class...
 
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.
 
virtual ~Auditor ()
 Destructor.
 
StatusCode sysInitialize ()
 Initialization method invoked by the framework.
 
StatusCode sysFinalize ()
 Finalization method invoked by the framework.
 
virtual void beforeInitialize (INamedInterface *)
 
virtual void afterInitialize (INamedInterface *)
 
virtual void beforeReinitialize (INamedInterface *)
 
virtual void afterReinitialize (INamedInterface *)
 
virtual void beforeExecute (INamedInterface *)
 
virtual void afterExecute (INamedInterface *, const StatusCode &)
 
virtual void beforeFinalize (INamedInterface *)
 
virtual void afterFinalize (INamedInterface *)
 
virtual void beforeBeginRun (INamedInterface *)
 
virtual void afterBeginRun (INamedInterface *)
 
virtual void beforeEndRun (INamedInterface *)
 
virtual void afterEndRun (INamedInterface *)
 
virtual StatusCode finalize ()
 
virtual const std::stringname () const
 
virtual bool isEnabled () const
 
SmartIF< IMessageSvc > & msgSvc () const
 The standard message service.
 
int outputLevel () const
 Retrieve the output level of current auditor.
 
void setOutputLevel (int level)
 Set the output level for current auditor.
 
SmartIF< ISvcLocator > & serviceLocator () const
 The standard service locator.
 
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.
 
virtual StatusCode setProperty (const Property &p)
 Set a value of a property of an auditor.
 
virtual StatusCode setProperty (const std::string &s)
 Implementation of IProperty::setProperty.
 
virtual StatusCode setProperty (const std::string &n, const std::string &v)
 Implementation of IProperty::setProperty.
 
virtual StatusCode getProperty (Property *p) const
 Get the value of a property.
 
virtual const PropertygetProperty (const std::string &name) const
 Get the property by name.
 
virtual StatusCode getProperty (const std::string &n, std::string &v) const
 Implementation of IProperty::getProperty.
 
const std::vector< Property * > & getProperties () const
 Get all properties.
 
template<class TYPE >
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value
 
StatusCode setProperties ()
 Set the auditor's properties.
 
template<class T >
PropertydeclareProperty (const std::string &name, T &property, const std::string &doc="none") const
 Declare the named property.
 

Private Member Functions

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

Private Attributes

SmartIF< IChronoStatSvcm_chronoSvc
 

Additional Inherited Members

- Public Types inherited from implements2< IAuditor, IProperty >
typedef implements2 base_class
 Typedef to this class.
 
typedef extend_interfaces2
< IAuditor, IProperty
extend_interfaces_base
 Typedef to the base of this class.
 
typedef
extend_interfaces_base::ext_iids 
interfaces
 MPL set of all the implemented interfaces.
 
- Protected Member Functions inherited from CommonAuditor
bool i_auditEventType (const std::string &evt)
 Check if we are requested to audit the passed event type.
 
void i_updateCustomTypes (Property &)
 Update handler for the obsolete property CustomEventTypes.
 
- Protected Attributes inherited from CommonAuditor
StringArrayProperty m_types
 
StringArrayProperty m_customTypes
 

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 15 of file ChronoAuditor.cpp.

: CommonAuditor(name, pSvcLocator) {
}
ChronoAuditor::~ChronoAuditor ( )
virtual

Definition at line 19 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 39 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 34 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 21 of file ChronoAuditor.cpp.

{
if (UNLIKELY(sc.isFailure())) return sc;
m_chronoSvc = serviceLocator()->service("ChronoStatSvc");
log << MSG::ERROR << "Cannot get ChronoStatSvc" << endmsg;
}
}

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:

Generated at Wed Dec 4 2013 14:33:14 for Gaudi Framework, version v24r2 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004