IService Class Reference

General service interface definition. More...

#include <GaudiKernel/IService.h>

Inheritance diagram for IService:

Collaboration diagram for IService:

Public Member Functions
	DeclareInterfaceID (IService, 3, 0)
	InterfaceID.
virtual StatusCode	sysInitialize ()=0
	Initialize Service.
virtual StatusCode	sysStart ()=0
	Start Service.
virtual StatusCode	sysStop ()=0
	Stop Service.
virtual StatusCode	sysFinalize ()=0
	Finalize Service.
virtual StatusCode	sysReinitialize ()=0
	Re-initialize the Service.
virtual StatusCode	sysRestart ()=0
	Re-start the Service.
virtual StatusCode	configure ()=0
	Configuration (from OFFLINE to CONFIGURED).
virtual StatusCode	initialize ()=0
	Initialization (from CONFIGURED to INITIALIZED).
virtual StatusCode	start ()=0
	Start (from INITIALIZED to RUNNING).
virtual StatusCode	stop ()=0
	Stop (from RUNNING to INITIALIZED).
virtual StatusCode	finalize ()=0
	Finalize (from INITIALIZED to CONFIGURED).
virtual StatusCode	terminate ()=0
	Initialization (from CONFIGURED to OFFLINE).
virtual StatusCode	reinitialize ()=0
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).
virtual StatusCode	restart ()=0
	Initialization (from RUNNING to RUNNING, via INITIALIZED).
virtual Gaudi::StateMachine::State	FSMState () const =0
	Get the current state.
virtual Gaudi::StateMachine::State	targetFSMState () const =0
	When we are in the middle of a transition, get the state where the transition is leading us.
Public Member Functions inherited from INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID.
virtual const std::string &	name () const =0
	Retrieve the name of the instance.
virtual	~INamedInterface ()
	Virtual destructor (always needed for abstract classes).
Public Member Functions inherited from IInterface
virtual void *	i_cast (const InterfaceID &) const =0
	main cast function
virtual std::vector< std::string >	getInterfaceNames () 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.

Protected Member Functions
virtual void	setServiceManager (ISvcManager *)=0

Friends
class	ServiceManager

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< iid >	ext_iids
	Extra interfaces.
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface.

Detailed Description

General service interface definition.

Author

Pere Mato

Definition at line 19 of file IService.h.

Member Function Documentation

virtual StatusCode IService::configure ( )

pure virtual

Configuration (from OFFLINE to CONFIGURED).

IService::DeclareInterfaceID	(	IService	,
		3	,
		0
	)

InterfaceID.

virtual StatusCode IService::finalize ( )

pure virtual

Finalize (from INITIALIZED to CONFIGURED).

Implemented in GslSvc, Gaudi::ParticlePropertySvc, ChronoStatSvc, PartPropSvc, AuditorSvc, IssueLogger, and StatusCodeSvc.

virtual Gaudi::StateMachine::State IService::FSMState ( ) const

pure virtual

Get the current state.

virtual StatusCode IService::initialize ( )

pure virtual

Initialization (from CONFIGURED to INITIALIZED).

Implemented in GslSvc, Gaudi::ParticlePropertySvc, ChronoStatSvc, PartPropSvc, AuditorSvc, IssueLogger, and StatusCodeSvc.

virtual StatusCode IService::reinitialize ( )

pure virtual

Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).

Implemented in PartPropSvc, IssueLogger, and StatusCodeSvc.

virtual StatusCode IService::restart ( )

pure virtual

Initialization (from RUNNING to RUNNING, via INITIALIZED).

virtual void IService::setServiceManager ( ISvcManager *  )

protectedpure virtual

virtual StatusCode IService::start ( )

pure virtual

Start (from INITIALIZED to RUNNING).

virtual StatusCode IService::stop ( )

pure virtual

Stop (from RUNNING to INITIALIZED).

virtual StatusCode IService::sysFinalize ( )

pure virtual

Finalize Service.

Implemented in AuditorSvc.

virtual StatusCode IService::sysInitialize ( )

pure virtual

Initialize Service.

Implemented in AuditorSvc.

virtual StatusCode IService::sysReinitialize ( )

pure virtual

Re-initialize the Service.

virtual StatusCode IService::sysRestart ( )

pure virtual

Re-start the Service.

virtual StatusCode IService::sysStart ( )

pure virtual

Start Service.

virtual StatusCode IService::sysStop ( )

pure virtual

Stop Service.

virtual Gaudi::StateMachine::State IService::targetFSMState ( ) const

pure virtual

When we are in the middle of a transition, get the state where the transition is leading us.

Otherwise it returns the same state as state().

virtual StatusCode IService::terminate ( )

pure virtual

Initialization (from CONFIGURED to OFFLINE).

Friends And Related Function Documentation

friend class ServiceManager

friend

Definition at line 20 of file IService.h.

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r6/GaudiKernel/GaudiKernel/IService.h