Gaudi Framework, version v23r10

Home   Generated: Mon Sep 30 2013
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
IIncidentSvc Class Referenceabstract

The interface implemented by the IncidentSvc service. More...

#include <GaudiKernel/IIncidentSvc.h>

Inheritance diagram for IIncidentSvc:
Inheritance graph
[legend]
Collaboration diagram for IIncidentSvc:
Collaboration graph
[legend]

Public Member Functions

 DeclareInterfaceID (IIncidentSvc, 2, 0)
 InterfaceID.
 
virtual void addListener (IIncidentListener *lis, const std::string &type="", long priority=0, bool rethrow=false, bool singleShot=false)=0
 Add listener.
 
virtual void removeListener (IIncidentListener *lis, const std::string &type="")=0
 Remove listener.
 
virtual void fireIncident (const Incident &incident)=0
 Fire an Incident.
 
- Public Member Functions inherited from IInterface
virtual void * i_cast (const InterfaceID &) const =0
 main cast function
 
virtual std::vector< std::stringgetInterfaceNames () const =0
 Returns a vector of strings containing the names of all the implemented interfaces.
 
virtual unsigned long addRef ()=0
 Increment the reference count of Interface instance.
 
virtual unsigned long release ()=0
 Release Interface instance.
 
virtual unsigned long refCount () const =0
 Current reference count.
 
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)=0
 Set the void** to the pointer to the requested interface of the instance.
 
virtual ~IInterface ()
 Virtual destructor.
 

Additional Inherited Members

- 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.
 
typedef mpl::set1< iidext_iids
 Extra interfaces.
 
- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface.
 

Detailed Description

The interface implemented by the IncidentSvc service.

It is used by Listeners to declare themselves that they are interested by Incidents of a certain type and by Incident originators.

Author
Pere Mato

Definition at line 21 of file IIncidentSvc.h.

Member Function Documentation

virtual void IIncidentSvc::addListener ( IIncidentListener lis,
const std::string type = "",
long  priority = 0,
bool  rethrow = false,
bool  singleShot = false 
)
pure virtual

Add listener.

Parameters
lisListener address
typeIncident type
priorityPriority in handling incident

Implemented in IncidentSvc.

IIncidentSvc::DeclareInterfaceID ( IIncidentSvc  ,
,
 
)
virtual void IIncidentSvc::fireIncident ( const Incident incident)
pure virtual

Fire an Incident.

Parameters
Incidentbeing fired

Implemented in IncidentSvc.

virtual void IIncidentSvc::removeListener ( IIncidentListener lis,
const std::string type = "" 
)
pure virtual

Remove listener.

Parameters
lisListener address
typeIncident type

Implemented in IncidentSvc.


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

Generated at Mon Sep 30 2013 14:52:03 for Gaudi Framework, version v23r10 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004