All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
IAuditorSvc Class Referenceabstract

The interface implemented by the IAuditorSvc base class. More...

#include <GaudiKernel/IAuditorSvc.h>

Inheritance diagram for IAuditorSvc:
Collaboration diagram for IAuditorSvc:

Public Member Functions

 DeclareInterfaceIDMultiBase (IAuditorSvc, 3, 0)
 InterfaceID. More...
 
virtual IAuditorgetAuditor (const std::string &name)=0
 management functionality: retrieve an Auditor More...
 
- Public Member Functions inherited from extend_interfaces2< IService, IAuditor >
virtual ~extend_interfaces2 ()
 Virtual destructor. More...
 
- Public Member Functions inherited from IService
 DeclareInterfaceID (IService, 3, 0)
 InterfaceID. More...
 
virtual StatusCode sysInitialize ()=0
 Initialize Service. More...
 
virtual StatusCode sysStart ()=0
 Start Service. More...
 
virtual StatusCode sysStop ()=0
 Stop Service. More...
 
virtual StatusCode sysFinalize ()=0
 Finalize Service. More...
 
virtual StatusCode sysReinitialize ()=0
 Re-initialize the Service. More...
 
virtual StatusCode sysRestart ()=0
 Re-start the Service. More...
 
virtual StatusCode configure ()=0
 Configuration (from OFFLINE to CONFIGURED). More...
 
virtual StatusCode initialize ()=0
 Initialization (from CONFIGURED to INITIALIZED). More...
 
virtual StatusCode start ()=0
 Start (from INITIALIZED to RUNNING). More...
 
virtual StatusCode stop ()=0
 Stop (from RUNNING to INITIALIZED). More...
 
virtual StatusCode finalize ()=0
 Finalize (from INITIALIZED to CONFIGURED). More...
 
virtual StatusCode terminate ()=0
 Initialization (from CONFIGURED to OFFLINE). More...
 
virtual StatusCode reinitialize ()=0
 Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...
 
virtual StatusCode restart ()=0
 Initialization (from RUNNING to RUNNING, via INITIALIZED). More...
 
virtual Gaudi::StateMachine::State FSMState () const =0
 Get the current state. More...
 
virtual Gaudi::StateMachine::State targetFSMState () const =0
 When we are in the middle of a transition, get the state where the transition is leading us. More...
 
virtual ~IService ()
 virtual destructor More...
 
- Public Member Functions inherited from INamedInterface
 DeclareInterfaceID (INamedInterface, 1, 0)
 InterfaceID. More...
 
virtual const std::string & name () const =0
 Retrieve the name of the instance. More...
 
virtual ~INamedInterface ()
 Virtual destructor (always needed for abstract classes). More...
 
- Public Member Functions inherited from IInterface
virtual void * i_cast (const InterfaceID &) const =0
 main cast function More...
 
virtual std::vector< std::string > getInterfaceNames () const =0
 Returns a vector of strings containing the names of all the implemented interfaces. More...
 
virtual unsigned long addRef ()=0
 Increment the reference count of Interface instance. More...
 
virtual unsigned long release ()=0
 Release Interface instance. More...
 
virtual unsigned long refCount () const =0
 Current reference count. More...
 
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)=0
 Set the void** to the pointer to the requested interface of the instance. More...
 
virtual ~IInterface ()
 Virtual destructor. More...
 
- Public Member Functions inherited from IAuditor
 DeclareInterfaceID (IAuditor, 3, 0)
 InterfaceID. More...
 
virtual void before (StandardEventType, INamedInterface *)=0
 Audit the start of a standard "event". More...
 
virtual void before (StandardEventType, const std::string &)=0
 Audit the start of a standard "event" for callers that do not implement INamedInterface. More...
 
virtual void before (CustomEventTypeRef, INamedInterface *)=0
 Audit the start of a custom "event". More...
 
virtual void before (CustomEventTypeRef, const std::string &)=0
 Audit the start of a custom "event" for callers that do not implement INamedInterface. More...
 
virtual void after (StandardEventType, INamedInterface *, const StatusCode &sc=StatusCode(StatusCode::SUCCESS, true))=0
 Audit the end of a standard "event". More...
 
virtual void after (StandardEventType, const std::string &, const StatusCode &sc=StatusCode(StatusCode::SUCCESS, true))=0
 Audit the end of a standard "event" for callers that do not implement INamedInterface. More...
 
virtual void after (CustomEventTypeRef, INamedInterface *, const StatusCode &sc=StatusCode(StatusCode::SUCCESS, true))=0
 Audit the end of a custom "event". More...
 
virtual void after (CustomEventTypeRef, const std::string &, const StatusCode &sc=StatusCode(StatusCode::SUCCESS, true))=0
 Audit the end of a custom "event" for callers that do not implement INamedInterface. More...
 
virtual bool isEnabled () const =0
 Tell if the auditor is enabled or not. More...
 
virtual void beforeInitialize (INamedInterface *)=0
 
virtual void afterInitialize (INamedInterface *)=0
 
virtual void beforeReinitialize (INamedInterface *)=0
 
virtual void afterReinitialize (INamedInterface *)=0
 
virtual void beforeExecute (INamedInterface *)=0
 
virtual void afterExecute (INamedInterface *, const StatusCode &)=0
 
virtual void beforeBeginRun (INamedInterface *)=0
 
virtual void afterBeginRun (INamedInterface *)=0
 
virtual void beforeEndRun (INamedInterface *)=0
 
virtual void afterEndRun (INamedInterface *)=0
 
virtual void beforeFinalize (INamedInterface *)=0
 
virtual void afterFinalize (INamedInterface *)=0
 
virtual StatusCode sysInitialize ()=0
 Used by AuditorSvc. More...
 
virtual StatusCode sysFinalize ()=0
 Used by AuditorSvc. More...
 

Additional Inherited Members

- Public Types inherited from extend_interfaces2< IService, IAuditor >
typedef mpl::fold< typename
IService::iid::iids::type,
typename
IAuditor::iid::iids::type,
mpl::insert< mpl::_1, mpl::_2 >
>::type 
ext_iids
 MPL set of interfaces extended by this one. More...
 
- Public Types inherited from IInterface
enum  Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
 Return status. More...
 
typedef Gaudi::InterfaceId
< IInterface, 0, 0 > 
iid
 Interface ID. More...
 
typedef mpl::set1< iidext_iids
 Extra interfaces. More...
 
- Public Types inherited from IAuditor
enum  StandardEventType {
  Initialize, ReInitialize, Execute, BeginRun,
  EndRun, Finalize, Start, Stop,
  ReStart
}
 Defines the standard (= used by the framework) auditable event types. More...
 
typedef std::string CustomEventType
 Type used to allow users to specify a custom event to be audit. More...
 
typedef const CustomEventTypeCustomEventTypeRef
 Used in function calls for optimization purposes. More...
 
- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface. More...
 
- Protected Member Functions inherited from IService
virtual void setServiceManager (ISvcManager *)=0
 

Detailed Description

The interface implemented by the IAuditorSvc base class.

Author
Pere Mato

Definition at line 16 of file IAuditorSvc.h.

Member Function Documentation

IAuditorSvc::DeclareInterfaceIDMultiBase ( IAuditorSvc  ,
,
 
)
virtual IAuditor* IAuditorSvc::getAuditor ( const std::string &  name)
pure virtual

management functionality: retrieve an Auditor

Implemented in AuditorSvc.


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