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 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 (std::string_view nam)=0
	Remove a service from the "active" list of services of the factory.

virtual StatusCode	declareSvcType (std::string svcname, 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 int	getPriority (std::string_view name) const =0

virtual StatusCode	setPriority (std::string_view 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 void	outputLevelUpdate ()=0
	Function to call to update the outputLevel of the components (after a change in MessageSvc).

Public Member Functions inherited from IStateful
	DeclareInterfaceID (IStateful, 1, 0)
	InterfaceID.

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
template<Gaudi::IsInterface TARGET>
TARGET *	cast ()

template<Gaudi::IsInterface TARGET>
TARGET const *	cast () const

template<typename TARGET> requires ( !Gaudi::IsInterface<TARGET> )
TARGET *	cast ()

template<typename TARGET> requires ( !Gaudi::IsInterface<TARGET> )
TARGET const *	cast () const

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 () const =0
	Increment the reference count of Interface instance.

virtual unsigned long	release () const =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 ()=default
	Virtual destructor.

virtual void const *	i_cast (const InterfaceID &) const =0

void *	i_cast (const InterfaceID &iid)

Static Public Attributes
static const int	DEFAULT_SVC_PRIORITY = 100

Additional Inherited Members
Public Types inherited from IInterface
enum class	Status : StatusCode::code_t { FAILURE = 0 , SUCCESS = 1 , NO_INTERFACE , VERSMISMATCH , LAST_ERROR }
	Return status. More...

using	iid = Gaudi::InterfaceId<IInterface, 0, 0>
	Interface ID.

using	ext_iids = Gaudi::interface_list<iid>
	Extra interfaces.

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

Protected Member Functions inherited from IInterface
virtual unsigned long	decRef () const =0
	Decrement reference count and return the new reference count.

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 30 of file ISvcManager.h.

Member Function Documentation

◆ addService() [1/2]

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.

◆ addService() [2/2]

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.

◆ createService()

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.

NOTE: as this returns a &, the underlying implementation must guarantee that once created, these SmartIF remain pinned in their location, thus constraining the underlying implementation (i.e. one cannot use something like std::vector<SmartIF<IService>>). If this interface had used value-semantics, and returned just plain SmartIF<IService> (i.e. WITHOUT the &) then the underlying implementation would have much more freedom)

◆ DeclareInterfaceID()

ISvcManager::DeclareInterfaceID	(	ISvcManager	,
		4	,
		0	)

InterfaceID.

◆ declareSvcType()

virtual StatusCode ISvcManager::declareSvcType	(	std::string	svcname,
		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.

◆ getPriority()

virtual int ISvcManager::getPriority ( std::string_view name ) const

pure virtual

◆ loopCheckEnabled()

virtual bool ISvcManager::loopCheckEnabled ( ) const

pure virtual

Get the value of the initialization loop check flag.

◆ removeService() [1/2]

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.

◆ removeService() [2/2]

virtual StatusCode ISvcManager::removeService ( std::string_view 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.

◆ setLoopCheckEnabled()

virtual void ISvcManager::setLoopCheckEnabled ( bool en = true )

pure virtual

Set the value of the initialization loop check flag.

◆ setPriority()

virtual StatusCode ISvcManager::setPriority	(	std::string_view	name,
		int	pri )

pure virtual

Member Data Documentation

◆ DEFAULT_SVC_PRIORITY

const int ISvcManager::DEFAULT_SVC_PRIORITY = 100

static

Definition at line 35 of file ISvcManager.h.

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

GaudiKernel/include/GaudiKernel/ISvcManager.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addService() [1/2]

◆ addService() [2/2]

◆ createService()

◆ DeclareInterfaceID()

◆ declareSvcType()

◆ getPriority()

◆ loopCheckEnabled()

◆ removeService() [1/2]

◆ removeService() [2/2]

◆ setLoopCheckEnabled()

◆ setPriority()

Member Data Documentation

◆ DEFAULT_SVC_PRIORITY