| # Gaudi Framework, version v25r0 |

Home |  | Generated: Mon Feb 17 2014

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Attributes | List of all members
ISvcManager Class Referenceabstract

The ISvcManager is the interface implemented by the Service Factory in the Application Manager to support management functions. More...

`#include <GaudiKernel/ISvcManager.h>`

Inheritance diagram for ISvcManager:
[legend]
Collaboration diagram for ISvcManager:
[legend]

## Public Member Functions
| DeclareInterfaceID (ISvcManager, 4, 0)
| InterfaceID.
virtual StatusCode | addService (IService *svc, int prio=DEFAULT_SVC_PRIORITY)=0
| Add a service to the "active" list of services of the factory.
virtual StatusCode | addService (const std::string &typ, const std::string &nam, int prio)
| Add a service to the "active" list of services of the factory.
virtual StatusCode | addService (const Gaudi::Utils::TypeNameString &nametype, int prio=DEFAULT_SVC_PRIORITY)=0
| Add a service to the "active" list of services of the factory.
virtual StatusCode | removeService (IService *svc)=0
| Remove a service from the "active" list of services of the factory.
virtual StatusCode | removeService (const std::string &nam)=0
| Remove a service from the "active" list of services of the factory.
virtual StatusCode | declareSvcFactory (const ISvcFactory &, const std::string &)
| Declare an abstract factory for a given service type.
virtual StatusCode | declareSvcType (const std::string &svcname, const std::string &svctype)=0
| Declare the type of the service to be used when crating a given service name.
virtual SmartIF< IService > & | createService (const Gaudi::Utils::TypeNameString &nametype)=0
| Creates and instance of a service type that has been declared beforehand and assigns it a name.
virtual StatusCode | createService (const std::string &svctype, const std::string &svcname, IService *&svc)
| Creates and instance of a service type that has been declared beforehand and assigns it a name.
virtual StatusCode | getFactory (const std::string &, const ISvcFactory *&) const
| Access to service factory by name to create unmanaged services.
virtual StatusCode | initializeServices ()
| Initializes the list of "active" services.
virtual StatusCode | startServices ()
| Starts the list of "active" services.
virtual StatusCode | stopServices ()
| Stops the list of "active" services.
virtual StatusCode | finalizeServices ()
| Finalizes the list of "active" services.
virtual StatusCode | reinitializeServices ()
| Reinitializes the list of "active" services.
virtual StatusCode | restartServices ()
| Restarts the list of "active" services.
virtual int | getPriority (const std::string &name) const =0
virtual StatusCode | setPriority (const std::string &name, int pri)=0
virtual bool | loopCheckEnabled () const =0
| Get the value of the initialization loop check flag.
virtual void | setLoopCheckEnabled (bool en=true)=0
| Set the value of the initialization loop check flag.
Public Member Functions inherited from IComponentManager
| DeclareInterfaceID (IComponentManager, 1, 0)
| InterfaceID.
virtual const InterfaceID & | componentBaseInterface () const =0
| Basic interface id of the managed components.
virtual | ~IComponentManager ()
| Virtual destructor.
Public Member Functions inherited from IStateful
| DeclareInterfaceID (IStateful, 1, 0)
| InterfaceID.
virtual | ~IStateful ()
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 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.

## Static Public Attributes
static const int | DEFAULT_SVC_PRIORITY = 100

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

The ISvcManager is the interface implemented by the Service Factory in the Application Manager to support management functions.

Clients use this interface to declare abstract service factories, and to create concrete instances of services.

Author
  Pere Mato

Definition at line 29 of file ISvcManager.h.

## Member Function Documentation

virtual StatusCode ISvcManager::addService | ( | IService * | svc,
|  | int | prio = `DEFAULT_SVC_PRIORITY`
| ) |  |
| pure virtual

Add a service to the "active" list of services of the factory.

Parameters

  svc | Pointer to the service

Returns
  StatusCode indicating success or failure.

virtual StatusCode ISvcManager::addService | ( | const std::string & | typ,
|  | const std::string & | nam,
|  | int | prio
| ) |  |
| inline virtual

Add a service to the "active" list of services of the factory.

Parameters

  svc | Pointer to the service

Returns
  StatusCode indicating success or failure.

Definition at line 49 of file ISvcManager.h.

{
return addService(Gaudi::Utils::TypeNameString(nam,typ), prio);
}

virtual StatusCode ISvcManager::addService | ( | const Gaudi::Utils::TypeNameString & | nametype,
|  | int | prio = `DEFAULT_SVC_PRIORITY`
| ) |  |
| pure virtual

Add a service to the "active" list of services of the factory.

Parameters

  svc | Pointer to the service

Returns
  StatusCode indicating success or failure.

virtual SmartIF<IService>& ISvcManager::createService | ( | const Gaudi::Utils::TypeNameString & | nametype | ) |
| pure virtual

Creates and instance of a service type that has been declared beforehand and assigns it a name.

It returns a pointer to an IService.

Parameters

  nametype | name/type of the service to create

Returns
  SmartIF to the created service.

virtual StatusCode ISvcManager::createService | ( | const std::string & | svctype,
|  | const std::string & | svcname,
|  | IService *& | svc
| ) |  |
| inline virtual

Creates and instance of a service type that has been declared beforehand and assigns it a name.

It returns a pointer to an IService.

Parameters

  svctype | Service type name
  svcname | Service name to be set
  svc | Returned service pointer

Returns
  StatusCode indicating success or failure.

Definition at line 115 of file ISvcManager.h.

{
SmartIF<IService> s = createService(svctype + "/" + svcname);
svc = s.get();
if (svc) {
svc->addRef(); // Needed to maintain the correct reference counting.
return StatusCode::SUCCESS;
}
return StatusCode::FAILURE;
}

ISvcManager::DeclareInterfaceID | ( | ISvcManager | ,
|  | 4 | ,
|  | 0 |
| ) |  |

InterfaceID.

virtual StatusCode ISvcManager::declareSvcFactory | ( | const ISvcFactory & | ,
|  | const std::string & |
| ) |  |
| inline virtual

Declare an abstract factory for a given service type.

Parameters

  factory | Abstract factory reference
  svctype | Service type name

Returns
  StatusCode indicating success or failure.

Definition at line 82 of file ISvcManager.h.

{
// This function is never used.
return StatusCode::FAILURE;
}

virtual StatusCode ISvcManager::declareSvcType | ( | const std::string & | svcname,
|  | const std::string & | svctype
| ) |  |
| pure virtual

Declare the type of the service to be used when crating a given service name.

Parameters

  svcname | Service name
  svctype | Service type name

Returns
  StatusCode indicating success or failure.

virtual StatusCode ISvcManager::finalizeServices | ( |  | ) |
| inline virtual

Finalizes the list of "active" services.

Returns
  StatusCode indicating success or failure.

Definition at line 161 of file ISvcManager.h.

{ return finalize(); }

virtual StatusCode ISvcManager::getFactory | ( | const std::string & | ,
|  | const ISvcFactory *& |
| ) |  | const
| inline virtual

Access to service factory by name to create unmanaged services.

Parameters

  svc_type | [IN] Name of the service type
  fac | [OUT] Reference to store pointer to service factory

Returns
  StatusCode indicating success or failure.

Definition at line 133 of file ISvcManager.h.

{
// This function is never used.
return StatusCode::FAILURE;
}

virtual int ISvcManager::getPriority | ( | const std::string & | name | ) | const
| pure virtual

virtual StatusCode ISvcManager::initializeServices | ( |  | ) |
| inline virtual

Initializes the list of "active" services.

Returns
  StatusCode indicating success or failure.

Definition at line 143 of file ISvcManager.h.

{ return initialize(); }

virtual bool ISvcManager::loopCheckEnabled | ( |  | ) | const
| pure virtual

Get the value of the initialization loop check flag.

virtual StatusCode ISvcManager::reinitializeServices | ( |  | ) |
| inline virtual

Reinitializes the list of "active" services.

Returns
  StatusCode indicating success or failure.

Definition at line 167 of file ISvcManager.h.

{ return reinitialize(); }

virtual StatusCode ISvcManager::removeService | ( | IService * | svc | ) |
| pure virtual

Remove a service from the "active" list of services of the factory.

Parameters

  svc | Pointer to the service

Returns
  StatusCode indicating success or failure.

virtual StatusCode ISvcManager::removeService | ( | const std::string & | nam | ) |
| pure virtual

Remove a service from the "active" list of services of the factory.

Parameters

  svc | Pointer to the service

Returns
  StatusCode indicating success or failure.

virtual StatusCode ISvcManager::restartServices | ( |  | ) |
| inline virtual

Restarts the list of "active" services.

Returns
  StatusCode indicating success or failure.

Definition at line 173 of file ISvcManager.h.

{ return restart(); }

virtual void ISvcManager::setLoopCheckEnabled | ( | bool | en = `true` | ) |
| pure virtual

Set the value of the initialization loop check flag.

virtual StatusCode ISvcManager::setPriority | ( | const std::string & | name,
|  | int | pri
| ) |  |
| pure virtual

virtual StatusCode ISvcManager::startServices | ( |  | ) |
| inline virtual

Starts the list of "active" services.

Returns
  StatusCode indicating success or failure.

Definition at line 149 of file ISvcManager.h.

{ return start(); }

virtual StatusCode ISvcManager::stopServices | ( |  | ) |
| inline virtual

Stops the list of "active" services.

Returns
  StatusCode indicating success or failure.

Definition at line 155 of file ISvcManager.h.

{ return stop(); }

## Member Data Documentation

const int ISvcManager::DEFAULT_SVC_PRIORITY = 100
| static

Definition at line 34 of file ISvcManager.h.

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

- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v25r0/GaudiKernel/GaudiKernel/ISvcManager.h