All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
IService Class Referenceabstract

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. More...
 
virtual StatusCode sysInitialize ()=0
 Initialize Service. More...
 
virtual StatusCode sysStart ()=0
 Start Service. More...
 
virtual StatusCode sysStop ()=0
 Stop Service. More...
 
virtual StatusCode sysFinalize ()=0
 Finalize Service. More...
 
virtual StatusCode sysReinitialize ()=0
 Re-initialize the Service. More...
 
virtual StatusCode sysRestart ()=0
 Re-start the Service. More...
 
virtual StatusCode configure ()=0
 Configuration (from OFFLINE to CONFIGURED). More...
 
virtual StatusCode initialize ()=0
 Initialization (from CONFIGURED to INITIALIZED). More...
 
virtual StatusCode start ()=0
 Start (from INITIALIZED to RUNNING). More...
 
virtual StatusCode stop ()=0
 Stop (from RUNNING to INITIALIZED). More...
 
virtual StatusCode finalize ()=0
 Finalize (from INITIALIZED to CONFIGURED). More...
 
virtual StatusCode terminate ()=0
 Initialization (from CONFIGURED to OFFLINE). More...
 
virtual StatusCode reinitialize ()=0
 Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...
 
virtual StatusCode restart ()=0
 Initialization (from RUNNING to RUNNING, via INITIALIZED). More...
 
virtual Gaudi::StateMachine::State FSMState () const =0
 Get the current state. More...
 
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. More...
 
virtual ~IService ()
 virtual destructor More...
 
- Public Member Functions inherited from INamedInterface
 DeclareInterfaceID (INamedInterface, 1, 0)
 InterfaceID. More...
 
virtual const std::string & name () const =0
 Retrieve the name of the instance. More...
 
virtual ~INamedInterface ()
 Virtual destructor (always needed for abstract classes). 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 ()
 Virtual destructor. More...
 

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. More...
 
typedef mpl::set1< iidext_iids
 Extra interfaces. More...
 
- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface. More...
 

Detailed Description

General service interface definition.

Author
Pere Mato

Definition at line 19 of file IService.h.

Constructor & Destructor Documentation

virtual IService::~IService ( )
inlinevirtual

virtual destructor

Definition at line 82 of file IService.h.

82 {}

Member Function Documentation

virtual StatusCode IService::configure ( )
pure virtual

Configuration (from OFFLINE to CONFIGURED).

Implemented in ApplicationMgr, and Service.

IService::DeclareInterfaceID ( IService  ,
,
 
)
virtual Gaudi::StateMachine::State IService::FSMState ( ) const
pure virtual

Get the current state.

Implemented in ApplicationMgr, and Service.

virtual StatusCode IService::reinitialize ( )
pure virtual
virtual StatusCode IService::restart ( )
pure virtual

Initialization (from RUNNING to RUNNING, via INITIALIZED).

Implemented in ApplicationMgr, MinimalEventLoopMgr, and Service.

virtual void IService::setServiceManager ( ISvcManager )
protectedpure virtual

Implemented in Service, and ApplicationMgr.

virtual StatusCode IService::start ( )
pure virtual

Start (from INITIALIZED to RUNNING).

Implemented in MinimalEventLoopMgr, ApplicationMgr, Service, AppMgrRunable, StalledEventMonitor, and ToolSvc.

virtual StatusCode IService::stop ( )
pure virtual
virtual StatusCode IService::sysFinalize ( )
pure virtual

Finalize Service.

Implemented in ApplicationMgr, AuditorSvc, and Service.

virtual StatusCode IService::sysInitialize ( )
pure virtual

Initialize Service.

Implemented in ApplicationMgr, AuditorSvc, and Service.

virtual StatusCode IService::sysReinitialize ( )
pure virtual

Re-initialize the Service.

Implemented in ApplicationMgr, and Service.

virtual StatusCode IService::sysRestart ( )
pure virtual

Re-start the Service.

Implemented in ApplicationMgr, and Service.

virtual StatusCode IService::sysStart ( )
pure virtual

Start Service.

Implemented in ApplicationMgr, and Service.

virtual StatusCode IService::sysStop ( )
pure virtual

Stop Service.

Implemented in ApplicationMgr, and 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().

Implemented in ApplicationMgr, and Service.

virtual StatusCode IService::terminate ( )
pure virtual

Initialization (from CONFIGURED to OFFLINE).

Implemented in ApplicationMgr, and Service.

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: