The IAuditor is the interface implemented by the Auditor base class. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/Gaudi/IAuditor.h>

Inheritance diagram for Gaudi::IAuditor:

Collaboration diagram for Gaudi::IAuditor:

[legend]

Public Member Functions
	DeclareInterfaceID (IAuditor, 1, 0)

virtual void	before (std::string const &event, std::string const &caller, EventContext const &)=0
	Audit the start of a given "event" for a given call. More...

virtual void	after (std::string const &event, std::string const &caller, EventContext const &, StatusCode const &sc=StatusCode::SUCCESS)=0
	Audit the end of a given "event" for a given caller. More...

virtual bool	isEnabled () const =0
	Tell if the auditor is enabled or not. More...

virtual StatusCode	sysInitialize ()=0
	Used by AuditorSvc. More...

virtual StatusCode	sysFinalize ()=0
	Used by AuditorSvc. 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...

Public Member Functions inherited from IInterface
template<Gaudi::IsInterface TARGET>
TARGET *	cast ()

template<Gaudi::IsInterface TARGET>
TARGET const *	cast () const

template<typename TARGET >
	requires (!Gaudi::IsInterface< TARGET >) TARGET *cast()

template<typename TARGET >
	requires (!Gaudi::IsInterface< TARGET >) TARGET const *cast() const

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 () const =0
	Increment the reference count of Interface instance. More...

virtual unsigned long	release () const =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 ()=default
	Virtual destructor. More...

virtual void const *	i_cast (const InterfaceID &) const =0

void *	i_cast (const InterfaceID &iid)

Static Public Attributes
static constexpr std::string	Initialize = "Initialize"

static constexpr std::string	ReInitialize = "ReInitialize"

static constexpr std::string	Start = "Start"

static constexpr std::string	ReStart = "ReStart"

static constexpr std::string	Execute = "Execute"

static constexpr std::string	Stop = "Stop"

static constexpr std::string	Finalize = "Finalize"

Additional Inherited Members
Public Types inherited from IInterface
enum	Status : StatusCode::code_t { Status::FAILURE = 0, Status::SUCCESS = 1, Status::NO_INTERFACE, Status::VERSMISMATCH, Status::LAST_ERROR }
	Return status. More...

using	iid = Gaudi::InterfaceId< IInterface, 0, 0 >
	Interface ID. More...

using	ext_iids = Gaudi::interface_list< iid >
	Extra interfaces. More...

Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...

Protected Member Functions inherited from IInterface
virtual unsigned long	decRef () const =0
	Decrement reference count and return the new reference count. More...

Detailed Description

The IAuditor is the interface implemented by the Auditor base class.

Concrete auditors, derived from the Auditor base class are controlled via this interface.

Definition at line 26 of file IAuditor.h.

Member Function Documentation

◆ after()

virtual void Gaudi::IAuditor::after	(	std::string const &	event,
		std::string const &	caller,
		EventContext const &	,
		StatusCode const &	sc = `StatusCode::SUCCESS`
	)

pure virtual

Audit the end of a given "event" for a given caller.

◆ before()

virtual void Gaudi::IAuditor::before	(	std::string const &	event,
		std::string const &	caller,
		EventContext const &
	)

pure virtual

Audit the start of a given "event" for a given call.

◆ DeclareInterfaceID()

Gaudi::IAuditor::DeclareInterfaceID	(	IAuditor	,
		1	,
		0
	)

◆ isEnabled()

virtual bool Gaudi::IAuditor::isEnabled ( ) const

pure virtual

Tell if the auditor is enabled or not.

◆ sysFinalize()

virtual StatusCode Gaudi::IAuditor::sysFinalize ( )

pure virtual

Used by AuditorSvc.

◆ sysInitialize()

virtual StatusCode Gaudi::IAuditor::sysInitialize ( )

pure virtual

Used by AuditorSvc.

Member Data Documentation

◆ Execute

constexpr std::string Gaudi::IAuditor::Execute = "Execute"

staticconstexpr

Definition at line 51 of file IAuditor.h.

◆ Finalize

constexpr std::string Gaudi::IAuditor::Finalize = "Finalize"

staticconstexpr

Definition at line 53 of file IAuditor.h.

◆ Initialize

constexpr std::string Gaudi::IAuditor::Initialize = "Initialize"

staticconstexpr

Definition at line 47 of file IAuditor.h.

◆ ReInitialize

constexpr std::string Gaudi::IAuditor::ReInitialize = "ReInitialize"

staticconstexpr

Definition at line 48 of file IAuditor.h.

◆ ReStart

constexpr std::string Gaudi::IAuditor::ReStart = "ReStart"

staticconstexpr

Definition at line 50 of file IAuditor.h.

◆ Start

constexpr std::string Gaudi::IAuditor::Start = "Start"

staticconstexpr

Definition at line 49 of file IAuditor.h.

◆ Stop

constexpr std::string Gaudi::IAuditor::Stop = "Stop"

staticconstexpr

Definition at line 52 of file IAuditor.h.

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

GaudiKernel/include/Gaudi/IAuditor.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ after()

◆ before()

◆ DeclareInterfaceID()

◆ isEnabled()

◆ sysFinalize()

◆ sysInitialize()

Member Data Documentation

◆ Execute

◆ Finalize

◆ Initialize

◆ ReInitialize

◆ ReStart

◆ Start

◆ Stop