In This Package:

IIncidentSvc Class Reference

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

#include <GaudiKernel/IIncidentSvc.h>

Inheritance diagram for IIncidentSvc:

[legend]Collaboration diagram for IIncidentSvc:[legend]List of all members.

Public Types
	SUCCESS = 1
	Normal successful completion.
	NO_INTERFACE
	Requested interface is not available.
	VERSMISMATCH
	Requested interface version is incompatible.
	LAST_ERROR
	Last error.
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...
Public Member Functions
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.
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface)=0
	Query interfaces of Interface.
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance.
virtual unsigned long	release ()=0
	Release Interface instance.
Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Retrieve interface ID.

---

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 24 of file IIncidentSvc.h.

---

Member Enumeration Documentation

enum IInterface::Status [inherited]

Return status.

Enumerator:

SUCCESS	Normal successful completion.
NO_INTERFACE	Requested interface is not available.
VERSMISMATCH	Requested interface version is incompatible.
LAST_ERROR	Last error.

Reimplemented in IConversionSvc, IConverter, and IDataProviderSvc.

Definition at line 113 of file IInterface.h.

                {
    SUCCESS = 1,
    NO_INTERFACE,
    VERSMISMATCH,
    LAST_ERROR
  };

---

Member Function Documentation

static const InterfaceID& IIncidentSvc::interfaceID

(

)

[inline, static]

Retrieve interface ID.

Reimplemented from IInterface.

Definition at line 28 of file IIncidentSvc.h.

{ return IID_IIncidentSvc; }

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

Add listener.

Parameters:

	lis	Listener address
	type	Incident type
	priority	Priority in handling incident

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

Remove listener.

Parameters:

	lis	Listener address
	type	Incident type

virtual void IIncidentSvc::fireIncident

(

const Incident &

incident

)

[pure virtual]

Fire an Incident.

Parameters:

Incident

being fired

virtual StatusCode IInterface::queryInterface	(	const InterfaceID &	riid,
		void **	ppvInterface
	)			[pure virtual, inherited]

Query interfaces of Interface.

Parameters:

	riid	ID of Interface to be retrieved
	ppvInterface	Pointer to Location for interface pointer

Implemented in Algorithm, AlgTool, Auditor, ConversionSvc, Converter, DataSvc, EventSelectorDataStream, MinimalEventLoopMgr, PropertyMgr, SelectStatement, and Service.

virtual unsigned long IInterface::addRef

(

)

[pure virtual, inherited]

Increment the reference count of Interface instance.

Implemented in Algorithm, AlgTool, Auditor, Converter, EventSelectorDataStream, IFactory, PropertyMgr, SelectStatement, and Service.

virtual unsigned long IInterface::release

(

)

[pure virtual, inherited]

Release Interface instance.

Implemented in Algorithm, AlgTool, Auditor, Converter, EventSelectorDataStream, IFactory, PropertyMgr, SelectStatement, and Service.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiKernel/GaudiKernel/IIncidentSvc.h

---