| The Gaudi Framework v32r1 (f65d50dc)

Public Member Functions | Private Member Functions | Private Attributes | List of all members
AlgContextAuditor Class Reference

Description: Register/Unregister the AlgContext of each algorithm before entering the algorithm and after leaving it. More...

`#include <src/AlgContextAuditor.h>`

Inheritance diagram for AlgContextAuditor:
[legend]
Collaboration diagram for AlgContextAuditor:
[legend]

## Public Member Functions
void | beforeInitialize (INamedInterface *a) override
void | afterInitialize (INamedInterface *a) override
void | beforeExecute (INamedInterface *a) override
void | afterExecute (INamedInterface *a, const StatusCode &s) override
void | beforeFinalize (INamedInterface *a) override
void | afterFinalize (INamedInterface *a) override
| AlgContextAuditor (const std::string &name, ISvcLocator *pSvc)
| standard constructor/destructor More...
StatusCode | initialize () override
| standard initialization, More...
StatusCode | finalize () override
| standard finalization, More...
Public Member Functions inherited from Auditor
| 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
void | beforeBeginRun (INamedInterface *) override
void | afterBeginRun (INamedInterface *) override
void | beforeEndRun (INamedInterface *) override
void | afterEndRun (INamedInterface *) override
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 Member Functions
| AlgContextAuditor ()=delete
| delete the default/copy constructor and assignment More...
| AlgContextAuditor (const AlgContextAuditor &)=delete
AlgContextAuditor & | operator= (const AlgContextAuditor &)=delete

## Private Attributes
SmartIF< IAlgContextSvc > | m_svc
| the pointer to Algorithm Context Service More...

## 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 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

Description: Register/Unregister the AlgContext of each algorithm before entering the algorithm and after leaving it.

Author
  M. Shapiro, LBNL
  modified by Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Definition at line 21 of file AlgContextAuditor.h.

## Constructor & Destructor Documentation

## ◆ AlgContextAuditor() [1/3]

AlgContextAuditor::AlgContextAuditor | ( | const std::string & | name,
|  | ISvcLocator * | pSvc
| ) |  |

standard constructor/destructor

See also
  Auditor

Definition at line 37 of file AlgContextAuditor.cpp.

37 : Auditor( name, pSvc ) {}
Auditor::Auditor
Auditor(const std::string &name, ISvcLocator *svcloc)
Constructor.
Definition: Auditor.cpp:12
Auditor::name
const std::string & name() const override
Definition: Auditor.cpp:193

## ◆ AlgContextAuditor() [2/3]

AlgContextAuditor::AlgContextAuditor | ( |  | ) |
| private delete

delete the default/copy constructor and assignment

## ◆ AlgContextAuditor() [3/3]

AlgContextAuditor::AlgContextAuditor | ( | const AlgContextAuditor & |  | ) |
| private delete

## Member Function Documentation

## ◆ afterExecute()

void AlgContextAuditor::afterExecute | ( | INamedInterface * | a,
|  | const StatusCode & | s
| ) |  |
| override

Definition at line 71 of file AlgContextAuditor.cpp.

71 {
72 call<&IAlgContextSvc::unSetCurrentAlg>( m_svc, a );
73 }
AlgContextAuditor::m_svc
SmartIF< IAlgContextSvc > m_svc
the pointer to Algorithm Context Service
Definition: AlgContextAuditor.h:49

## ◆ afterFinalize()

void AlgContextAuditor::afterFinalize | ( | INamedInterface * | a | ) |
| override

Definition at line 67 of file AlgContextAuditor.cpp.

67 { call<&IAlgContextSvc::unSetCurrentAlg>( m_svc, a ); }
AlgContextAuditor::m_svc
SmartIF< IAlgContextSvc > m_svc
the pointer to Algorithm Context Service
Definition: AlgContextAuditor.h:49

## ◆ afterInitialize()

void AlgContextAuditor::afterInitialize | ( | INamedInterface * | a | ) |
| override

Definition at line 63 of file AlgContextAuditor.cpp.

63 { call<&IAlgContextSvc::unSetCurrentAlg>( m_svc, a ); }
AlgContextAuditor::m_svc
SmartIF< IAlgContextSvc > m_svc
the pointer to Algorithm Context Service
Definition: AlgContextAuditor.h:49

## ◆ beforeExecute()

void AlgContextAuditor::beforeExecute | ( | INamedInterface * | a | ) |
| override

Definition at line 69 of file AlgContextAuditor.cpp.

69 { call<&IAlgContextSvc::setCurrentAlg>( m_svc, a ); }
AlgContextAuditor::m_svc
SmartIF< IAlgContextSvc > m_svc
the pointer to Algorithm Context Service
Definition: AlgContextAuditor.h:49

## ◆ beforeFinalize()

void AlgContextAuditor::beforeFinalize | ( | INamedInterface * | a | ) |
| override

Definition at line 65 of file AlgContextAuditor.cpp.

65 { call<&IAlgContextSvc::setCurrentAlg>( m_svc, a ); }
AlgContextAuditor::m_svc
SmartIF< IAlgContextSvc > m_svc
the pointer to Algorithm Context Service
Definition: AlgContextAuditor.h:49

## ◆ beforeInitialize()

void AlgContextAuditor::beforeInitialize | ( | INamedInterface * | a | ) |
| override

Definition at line 61 of file AlgContextAuditor.cpp.

61 { call<&IAlgContextSvc::setCurrentAlg>( m_svc, a ); }
AlgContextAuditor::m_svc
SmartIF< IAlgContextSvc > m_svc
the pointer to Algorithm Context Service
Definition: AlgContextAuditor.h:49

## ◆ finalize()

StatusCode AlgContextAuditor::finalize | ( |  | ) |
| override virtual

standard finalization,

See also
  IAuditor

Reimplemented from Auditor.

Definition at line 55 of file AlgContextAuditor.cpp.

55 {
56 m_svc.reset();
57 // finalize the base class
58 return Auditor::finalize();
59 }
Auditor::finalize
virtual StatusCode finalize()
Definition: Auditor.cpp:191
AlgContextAuditor::m_svc
SmartIF< IAlgContextSvc > m_svc
the pointer to Algorithm Context Service
Definition: AlgContextAuditor.h:49
SmartIF::reset
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:86

## ◆ initialize()

StatusCode AlgContextAuditor::initialize | ( |  | ) |
| override virtual

standard initialization,

See also
  IAuditor

Reimplemented from Auditor.

Definition at line 41 of file AlgContextAuditor.cpp.

41 {
42 // initialize the base class
43 StatusCode sc = Auditor::initialize();
44 if ( sc.isFailure() ) { return sc; } // RETURN
45 m_svc = service( "AlgContextSvc", true );
46 if ( !m_svc ) {
47 error() << "Invalid pointer to IAlgContextSvc" << endmsg;
48 return StatusCode::FAILURE; // RETURN
49 }
50 return StatusCode::SUCCESS;
51 }
Auditor::service
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.
Definition: Auditor.h:105
StatusCode::SUCCESS
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
AlgContextAuditor::m_svc
SmartIF< IAlgContextSvc > m_svc
the pointer to Algorithm Context Service
Definition: AlgContextAuditor.h:49
CommonMessagingBase::error
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
Definition: CommonMessaging.h:98
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
StatusCode::FAILURE
constexpr static const auto FAILURE
Definition: StatusCode.h:86
Auditor::initialize
virtual StatusCode initialize()
Definition: Auditor.cpp:64
StatusCode::isFailure
bool isFailure() const
Definition: StatusCode.h:130
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192

## ◆ operator=()

AlgContextAuditor& AlgContextAuditor::operator= | ( | const AlgContextAuditor & |  | ) |
| private delete

## Member Data Documentation

## ◆ m_svc

SmartIF<IAlgContextSvc> AlgContextAuditor::m_svc
| private

the pointer to Algorithm Context Service

Definition at line 49 of file AlgContextAuditor.h.

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

- GaudiAud/src/AlgContextAuditor.h
- GaudiAud/src/AlgContextAuditor.cpp