The Gaudi Framework  master (37c0b60a)
ChronoAuditor Class Reference

#include </builds/gaudi/Gaudi/GaudiAud/src/ChronoAuditor.h>

Inheritance diagram for ChronoAuditor:
Collaboration diagram for ChronoAuditor:

Public Member Functions

StatusCode initialize () override
 
- Public Member Functions inherited from CommonAuditor
 Auditor (std::string name, ISvcLocator *svcloc)
 Constructor. More...
 
 Auditor (const Auditor &a)=delete
 Constructor. More...
 
void before (StandardEventType evt, const std::string &caller) override
 
void before (StandardEventType evt, INamedInterface *caller) override
 
void before (CustomEventTypeRef evt, const std::string &caller) override
 
void before (CustomEventTypeRef evt, INamedInterface *caller) override
 
void after (StandardEventType evt, const std::string &caller, const StatusCode &sc) override
 
void after (StandardEventType evt, INamedInterface *caller, const StatusCode &sc) override
 
void after (CustomEventTypeRef evt, const std::string &caller, const StatusCode &sc) override
 
void after (CustomEventTypeRef evt, INamedInterface *caller, const StatusCode &sc) override
 
- Public Member Functions inherited from Auditor
 Auditor (std::string name, ISvcLocator *svcloc)
 Constructor. More...
 
 Auditor (const Auditor &a)=delete
 
Auditoroperator= (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 finalize ()
 
const std::stringname () const override
 
bool isEnabled () const override
 
SmartIF< ISvcLocator > & serviceLocator () const override
 The standard service locator. More...
 
template<class T >
StatusCode service (std::string_view 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 (std::string_view name, bool createIf=false) const
 
- Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
 PropertyHolder ()=default
 
Gaudi::Details::PropertyBasedeclareProperty (Gaudi::Details::PropertyBase &prop)
 Declare a property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (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::PropertyBasedeclareProperty (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::PropertyBasedeclareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
 Declare a remote property. More...
 
StatusCode setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
 set the property from another property with a different name More...
 
StatusCode setProperty (const std::string &s) override
 set the property from the formatted string More...
 
StatusCode setProperty (const Gaudi::Details::PropertyBase &p)
 Set the property from a property. More...
 
virtual StatusCode setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
 Set the property from a property with a different name. More...
 
virtual StatusCode setProperty (const std::string &s)=0
 Set the property by string. More...
 
StatusCode setProperty (const std::string &name, const char *v)
 Special case for string literals. More...
 
StatusCode setProperty (const std::string &name, const std::string &v)
 Special case for std::string. More...
 
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value More...
 
StatusCode setPropertyRepr (const std::string &n, const std::string &r) override
 set the property from name and value string representation More...
 
StatusCode getProperty (Gaudi::Details::PropertyBase *p) const override
 get the property More...
 
const Gaudi::Details::PropertyBasegetProperty (std::string_view name) const override
 get the property by name More...
 
StatusCode getProperty (std::string_view 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 (std::string_view name) const override
 Return true if we have a property with the given name. More...
 
Gaudi::Details::PropertyBaseproperty (std::string_view name) const
 \fixme property and bindPropertiesTo should be protected More...
 
void bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)
 
 PropertyHolder (const PropertyHolder &)=delete
 
PropertyHolderoperator= (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...
 

Private Member Functions

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

Private Attributes

SmartIF< IChronoStatSvcm_chronoSvc
 

Additional Inherited Members

- Public Types inherited from Auditor
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
 
- Protected Member Functions inherited from CommonAuditor
bool i_auditEventType (std::string_view evt)
 Check if we are requested to audit the passed event type. More...
 
- 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

Monitors the cpu time usage of each algorithm

Author
David Quarrie
Marco Clemencic

Definition at line 24 of file ChronoAuditor.h.

Member Function Documentation

◆ chronoSvc()

SmartIF<IChronoStatSvc>& ChronoAuditor::chronoSvc ( )
inlineprivate

Definition at line 40 of file ChronoAuditor.h.

40 { return m_chronoSvc; }

◆ i_after()

void ChronoAuditor::i_after ( CustomEventTypeRef  evt,
std::string_view  caller,
const StatusCode sc 
)
overrideprivatevirtual

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

Implements CommonAuditor.

Definition at line 33 of file ChronoAuditor.cpp.

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

◆ i_before()

void ChronoAuditor::i_before ( CustomEventTypeRef  evt,
std::string_view  caller 
)
overrideprivatevirtual

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

Implements CommonAuditor.

Definition at line 29 of file ChronoAuditor.cpp.

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

◆ i_id()

std::string ChronoAuditor::i_id ( CustomEventTypeRef  evt,
std::string_view  caller 
)
inlineprivate

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

Definition at line 38 of file ChronoAuditor.h.

38 { return std::string{ caller } + ":" + evt; }

◆ initialize()

StatusCode ChronoAuditor::initialize ( )
overridevirtual

Reimplemented from Auditor.

Definition at line 18 of file ChronoAuditor.cpp.

18  {
19  return CommonAuditor::initialize().andThen( [&]() -> StatusCode {
20  m_chronoSvc = serviceLocator()->service( "ChronoStatSvc" );
21  if ( !m_chronoSvc.get() ) {
22  error() << "Cannot get ChronoStatSvc" << endmsg;
23  return StatusCode::FAILURE;
24  }
25  return StatusCode::SUCCESS;
26  } );
27 }

Member Data Documentation

◆ m_chronoSvc

SmartIF<IChronoStatSvc> ChronoAuditor::m_chronoSvc
private

Definition at line 41 of file ChronoAuditor.h.


The documentation for this class was generated from the following files:
IOTest.evt
evt
Definition: IOTest.py:107
ChronoAuditor::m_chronoSvc
SmartIF< IChronoStatSvc > m_chronoSvc
Definition: ChronoAuditor.h:41
std::string
STL class.
StatusCode::andThen
StatusCode andThen(F &&f, ARGS &&... args) const
Chain code blocks making the execution conditional a success result.
Definition: StatusCode.h:163
ChronoAuditor::chronoSvc
SmartIF< IChronoStatSvc > & chronoSvc()
Definition: ChronoAuditor.h:40
ChronoAuditor::i_id
std::string i_id(CustomEventTypeRef evt, std::string_view caller)
Compute the id string to be used for the chrono entity.
Definition: ChronoAuditor.h:38
Auditor::initialize
virtual StatusCode initialize()
Definition: Auditor.cpp:79
StatusCode
Definition: StatusCode.h:65
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:202
StatusCode::SUCCESS
constexpr static const auto SUCCESS
Definition: StatusCode.h:100
SmartIF::get
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:86
StatusCode::FAILURE
constexpr static const auto FAILURE
Definition: StatusCode.h:101
Auditor::serviceLocator
SmartIF< ISvcLocator > & serviceLocator() const override
The standard service locator.
Definition: Auditor.cpp:196