IInterface Class Reference

#include <GaudiKernel/IInterface.h>

Inheritance diagram for IInterface:

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

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

Static Public Member Functions
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 237 of file IInterface.h.

Member Typedef Documentation

ext_iids

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

Extra interfaces.

Definition at line 243 of file IInterface.h.

iid

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

Interface ID.

Definition at line 240 of file IInterface.h.

Member Enumeration Documentation

Status

enum IInterface::Status : StatusCode::code_t

strong

Return status.

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

Definition at line 290 of file IInterface.h.

                    : StatusCode::code_t {
    FAILURE = 0,
    SUCCESS = 1,
    NO_INTERFACE,
    VERSMISMATCH,
    LAST_ERROR
  };

Constructor & Destructor Documentation

~IInterface()

virtual IInterface::~IInterface ( )

virtualdefault

Virtual destructor.

Member Function Documentation

addRef()

virtual unsigned long IInterface::addRef ( )

pure virtual

Increment the reference count of Interface instance.

getInterfaceNames()

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

pure virtual

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

i_cast()

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

pure virtual

main cast function

interfaceID()

static const InterfaceID& IInterface::interfaceID ( )

inlinestatic

Return an instance of InterfaceID identifying the interface.

Definition at line 246 of file IInterface.h.

{ return iid::interfaceID(); }

queryInterface()

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

pure virtual

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

refCount()

virtual unsigned long IInterface::refCount ( ) const

pure virtual

Current reference count.

release()

virtual unsigned long IInterface::release ( )

pure virtual

Release Interface instance.

---

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

• GaudiKernel/include/GaudiKernel/IInterface.h