IIncidentSvc Class Referenceabstract

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

#include <GaudiKernel/IIncidentSvc.h>

Inheritance diagram for IIncidentSvc:
Collaboration diagram for IIncidentSvc:

Public Member Functions

 DeclareInterfaceID (IIncidentSvc, 2, 0)
 InterfaceID. More...
 
virtual void addListener (IIncidentListener *lis, const std::string &type="", long priority=0, bool rethrow=false, bool singleShot=false)=0
 Add listener. More...
 
virtual void removeListener (IIncidentListener *lis, const std::string &type="")=0
 Remove listener. More...
 
virtual void getListeners (std::vector< IIncidentListener * > &lis, const std::string &type="") const =0
 
virtual void fireIncident (const Incident &incident)=0
 Fire an Incident. More...
 
 DeclareInterfaceID (IIncidentSvc, 2, 0)
 InterfaceID. More...
 
virtual void addListener (IIncidentListener *lis, const std::string &type="", long priority=0, bool rethrow=false, bool singleShot=false)=0
 Add listener. More...
 
virtual void removeListener (IIncidentListener *lis, const std::string &type="")=0
 Remove listener. More...
 
virtual void getListeners (std::vector< IIncidentListener * > &lis, const std::string &type="") const =0
 
virtual void fireIncident (const Incident &incident)=0
 Fire an Incident. 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 ()=default
 Virtual destructor. More...
 
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 ()=default
 Virtual destructor. More...
 

Additional Inherited Members

- Public Types inherited from IInterface
enum  Status {
  SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR,
  SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR
}
 Return status. More...
 
enum  Status {
  SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR,
  SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, 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...
 
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 InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface. More...
 
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface. More...
 

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
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
IIncidentSvc::DeclareInterfaceID ( IIncidentSvc  ,
,
 
)
IIncidentSvc::DeclareInterfaceID ( IIncidentSvc  ,
,
 
)
virtual void IIncidentSvc::fireIncident ( const Incident incident)
pure virtual

Fire an Incident.

Parameters
Incidentbeing fired
virtual void IIncidentSvc::fireIncident ( const Incident incident)
pure virtual

Fire an Incident.

Parameters
Incidentbeing fired
virtual void IIncidentSvc::getListeners ( std::vector< IIncidentListener * > &  lis,
const std::string &  type = "" 
) const
pure virtual
virtual void IIncidentSvc::getListeners ( std::vector< IIncidentListener * > &  lis,
const std::string &  type = "" 
) const
pure virtual
virtual void IIncidentSvc::removeListener ( IIncidentListener lis,
const std::string &  type = "" 
)
pure virtual

Remove listener.

Parameters
lisListener address
typeIncident type
virtual void IIncidentSvc::removeListener ( IIncidentListener lis,
const std::string &  type = "" 
)
pure virtual

Remove listener.

Parameters
lisListener address
typeIncident type

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