Definition of the basic interface. More...

#include <GaudiKernel/IInterface.h>

Inherited by Gaudi::IFileCatalog [virtual], Gaudi::IFileCatalog [virtual], Gaudi::IFileCatalogMgr [virtual], Gaudi::IFileCatalogMgr [virtual], Gaudi::IIODataManager [virtual], Gaudi::IIODataManager [virtual], Gaudi::ISignalMonitor [virtual], Gaudi::ISignalMonitor [virtual], IAddressCreator [virtual], IAddressCreator [virtual], IAlgContextSvc [virtual], IAlgContextSvc [virtual], IChronoSvc [virtual], IChronoSvc [virtual], IClassManager [virtual], IClassManager [virtual], IConverter [virtual], IConverter [virtual], ICounterSvc [virtual], ICounterSvc [virtual], IDataManagerSvc [virtual], IDataManagerSvc [virtual], IDataProviderSvc [virtual], IDataProviderSvc [virtual], IDataSourceMgr [virtual], IDataSourceMgr [virtual], IDetDataSvc [virtual], IDetDataSvc [virtual], IEventProcessor [virtual], IEventProcessor [virtual], IEvtSelector [virtual], IEvtSelector [virtual], IExceptionSvc [virtual], IExceptionSvc [virtual], IFileAccess [virtual], IFileAccess [virtual], IInactiveMessageCounter [virtual], IInactiveMessageCounter [virtual], IIncidentListener [virtual], IIncidentListener [virtual], IIncidentSvc [virtual], IIncidentSvc [virtual], IInspector [virtual], IInspector [virtual], IJobOptionsSvc [virtual], IJobOptionsSvc [virtual], IMessageSvc [virtual], IMessageSvc [virtual], IMonitorSvc [virtual], IMonitorSvc [virtual], INamedInterface [virtual], INamedInterface [virtual], IPartitionControl [virtual], IPartitionControl [virtual], IPersistencySvc [virtual], IPersistencySvc [virtual], IProperty [virtual], IProperty [virtual], IPublishSvc [virtual], IPublishSvc [virtual], IRndmEngine [virtual], IRndmEngine [virtual], IRndmGen [virtual], IRndmGen [virtual], IRunable [virtual], IRunable [virtual], ISelectStatement [virtual], ISelectStatement [virtual], ISerialize [virtual], ISerialize [virtual], IStagerSvc [virtual], IStagerSvc [virtual], IStateful [virtual], IStateful [virtual], IStatSvc [virtual], IStatSvc [virtual], ISvcLocator [virtual], ISvcLocator [virtual], IToolSvc [virtual], IToolSvc [virtual], IUpdateableIF [virtual], IUpdateableIF [virtual], IUpdateManagerSvc [virtual], and IUpdateManagerSvc [virtual].

Public Types
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...

Public Member Functions
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...

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

static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...

Detailed Description

Definition of the basic interface.

Author: Pere Mato; Markus Frank; Marco Clemencic

Definition at line 234 of file IInterface.h.

Member Typedef Documentation

using IInterface::ext_iids = Gaudi::interface_list<iid>

Extra interfaces.

Definition at line 240 of file IInterface.h.

using IInterface::ext_iids = Gaudi::interface_list<iid>

Extra interfaces.

Definition at line 240 of file IInterface.h.

using IInterface::iid = Gaudi::InterfaceId<IInterface,0,0>

Interface ID.

Definition at line 237 of file IInterface.h.

using IInterface::iid = Gaudi::InterfaceId<IInterface,0,0>

Interface ID.

Definition at line 237 of file IInterface.h.

Member Enumeration Documentation

enum IInterface::Status

Return status.

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

Definition at line 283 of file IInterface.h.

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

enum IInterface::Status

Return status.

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

Definition at line 283 of file IInterface.h.

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

Constructor & Destructor Documentation

virtual IInterface::~IInterface ( )

virtualdefault

Virtual destructor.

virtual IInterface::~IInterface ( )

virtualdefault

Virtual destructor.

Member Function Documentation

virtual unsigned long IInterface::addRef ( )

pure virtual

Increment the reference count of Interface instance.

virtual unsigned long IInterface::addRef ( )

pure virtual

Increment the reference count of Interface instance.

virtual std::vector<std::string> IInterface::getInterfaceNames ( ) const

pure virtual

Returns a vector of strings containing the names of all the implemented interfaces.

virtual std::vector<std::string> IInterface::getInterfaceNames ( ) const

pure virtual

Returns a vector of strings containing the names of all the implemented interfaces.

virtual void* IInterface::i_cast ( const InterfaceID & ) const

pure virtual

main cast function

virtual void* IInterface::i_cast ( const InterfaceID & ) const

pure virtual

main cast function

static const InterfaceID& IInterface::interfaceID ( )

inlinestatic

Return an instance of InterfaceID identifying the interface.

Definition at line 243 of file IInterface.h.

                                                 {
     return iid::interfaceID();
   }

static const InterfaceID& IInterface::interfaceID ( )

inlinestatic

Return an instance of InterfaceID identifying the interface.

Definition at line 243 of file IInterface.h.

                                                 {
     return iid::interfaceID();
   }

virtual StatusCode IInterface::queryInterface	(	const InterfaceID &	ti,
		void **	pp
	)

pure virtual

Set the void** to the pointer to the requested interface of the instance.

virtual StatusCode IInterface::queryInterface	(	const InterfaceID &	ti,
		void **	pp
	)

pure virtual

Set the void** to the pointer to the requested interface of the instance.

virtual unsigned long IInterface::refCount ( ) const

pure virtual

Current reference count.

virtual unsigned long IInterface::refCount ( ) const

pure virtual

Current reference count.

virtual unsigned long IInterface::release ( )

pure virtual

Release Interface instance.

virtual unsigned long IInterface::release ( )

pure virtual

Release Interface instance.

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

InstallArea/x86_64-slc6-gcc48-opt/include/GaudiKernel/IInterface.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation