Gaudi::Guards::AuditorGuard Class Reference

It is a simple guard, which "locks" the scope for the Auditor Service is am exception-safe way. More...

#include <GaudiKernel/Guards.h>

Collaboration diagram for Gaudi::Guards::AuditorGuard:

Public Member Functions
	AuditorGuard (INamedInterface *obj, IAuditor *svc, IAuditor::StandardEventType evt)
	constructor
	AuditorGuard (INamedInterface *obj, IAuditor *svc, IAuditor::CustomEventTypeRef evt)
	constructor
	AuditorGuard (INamedInterface *obj, IAuditor *svc, IAuditor::StandardEventType evt, const StatusCode &sc)
	constructor
	AuditorGuard (INamedInterface *obj, IAuditor *svc, IAuditor::CustomEventTypeRef evt, const StatusCode &sc)
	constructor
	AuditorGuard (const std::string &name, IAuditor *svc, IAuditor::StandardEventType evt)
	constructor
	AuditorGuard (const std::string &name, IAuditor *svc, IAuditor::CustomEventTypeRef evt)
	constructor
	AuditorGuard (const std::string &name, IAuditor *svc, IAuditor::StandardEventType evt, const StatusCode &sc)
	constructor
	AuditorGuard (const std::string &name, IAuditor *svc, IAuditor::CustomEventTypeRef evt, const StatusCode &sc)
	constructor
	~AuditorGuard ()
	dectructor
const StatusCode &	code () const

Private Member Functions
	AuditorGuard ()
	the default constructor is disabled
	AuditorGuard (const AuditorGuard &right)
	no copy
AuditorGuard &	operator= (const AuditorGuard &right)
	no assignement
void	i_before ()
void	i_after ()

Private Attributes
INamedInterface *	m_obj
	the guarded object
std::string	m_objName
	the guarded object name (if there is no INamedInterface)
IAuditor *	m_svc
	auditor service
IAuditor::StandardEventType	m_evt
	Event type (standard events)
IAuditor::CustomEventType	m_cevt
	Event type (custom events)
const StatusCode *	m_sc
	Pointer to a status code instance, to be passed to the "after" function if needed The instance must have a scope larger than the one of the guard.
bool	m_customEvtType
	Flag to remember which event type was used.

Detailed Description

It is a simple guard, which "locks" the scope for the Auditor Service is am exception-safe way.

The pattern ensures that "post-action" will be always executed

StatusCode Algorithm::sysInitialize ()
 {
    AuditorGuard auditor ( this ,
      auditSvc()                ,   
      IAuditor::Initialize      ) ; 
    ...
    StatusCode sc = ... ;
    ...
    return sc ;                  
 }

StatusCode Algorithm::sysExecute ()
 {
    AuditorGuard auditor ( this       ,
      auditSvc()                      ,   
      IAuditor::execute               ) ; 
    ...
    StatusCode sc = ... ;
    ...
    auditor.setCode ( sc ) ;
    ...
    return sc ;                  
 }

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-03-07

Definition at line 218 of file Guards.h.

Constructor & Destructor Documentation

Gaudi::Guards::AuditorGuard::AuditorGuard	(	INamedInterface *	obj,
		IAuditor *	svc,
		IAuditor::StandardEventType	evt
	)

constructor

Definition at line 65 of file Guards.cpp.

                                                                   :
                 m_obj(obj),
                 m_objName(),
                 m_svc(svc),
                 m_evt(evt),
                 m_cevt(),
                 m_sc(0),
                 m_customEvtType(false)
{
  i_before();