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 | List of all members
NameAuditor Class Reference

Prints the name of each algorithm before entering the algorithm and after leaving it. More...

#include <NameAuditor.h>

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

Public Member Functions

 NameAuditor (const std::string &name, ISvcLocator *pSvcLocator)
 
- 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 initialize ()
 
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)
 Print a message on "before".
 
virtual void i_after (CustomEventTypeRef evt, const std::string &caller, const StatusCode &sc)
 Print a message on "after".
 

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

Prints the name of each algorithm before entering the algorithm and after leaving it.

Author
M. Shapiro, LBNL
Marco Clemencic

Definition at line 11 of file NameAuditor.h.

Constructor & Destructor Documentation

NameAuditor::NameAuditor ( const std::string name,
ISvcLocator pSvcLocator 
)

Definition at line 12 of file NameAuditor.cpp.

:
CommonAuditor(name, pSvcLocator) {
}

Member Function Documentation

void NameAuditor::i_after ( CustomEventTypeRef  evt,
const std::string caller,
const StatusCode sc 
)
privatevirtual

Print a message on "after".

Implements CommonAuditor.

Definition at line 23 of file NameAuditor.cpp.

{
log << MSG::INFO << "Just Exited " << caller << " with auditor trigger "
<< evt << endmsg;
}
void NameAuditor::i_before ( CustomEventTypeRef  evt,
const std::string caller 
)
privatevirtual

Print a message on "before".

Implements CommonAuditor.

Definition at line 16 of file NameAuditor.cpp.

{
log << MSG::INFO << "About to Enter " << caller << " with auditor trigger "
<< evt << endmsg;
}

The documentation for this class was generated from the following files:
Generated at Wed Dec 4 2013 14:33:18 for Gaudi Framework, version v24r2 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004