#include <GaudiKernel/ServiceHandle.h>

Inheritance diagram for ServiceHandle< T >:

[legend]

Collaboration diagram for ServiceHandle< T >:

[legend]

Public Member Functions
	ServiceHandle (const std::string &serviceName, const std::string &theParentName)
	Create a handle ('smart pointer') to a service. More...

template<typename CT = T, typename NCT = std::remove_const_t<T>>
	requires (std::is_const_v< CT > &&!std::is_same_v< CT, NCT >) ServiceHandle(const ServiceHandle< NCT > &other)
	Copy constructor from a non const T to const T service handle. More...

template<std::derived_from< IProperty > OWNER>
	ServiceHandle (OWNER *owner, std::string PropName, const std::string &svcName, std::string doc="")
	Autodeclaring constructor with property name, service type/name and documentation. More...

StatusCode	initialize (const std::string &serviceName, const std::string &theParentName)

T *	get () const
	Allow non const access to the service, even from a const handle... More...

T *	operator-> () const
	Allow non const access to the service, even from a const handle... More...

T &	operator* () const

Public Member Functions inherited from GaudiHandle< T >
template<typename CT = T, typename NCT = std::remove_const_t<T>>
	GaudiHandle (const GaudiHandle< NCT > &other) requires(std
	Copy constructor needed for correct ref-counting. More...

	GaudiHandle (const GaudiHandle &other)
	Copy constructor needed for correct ref-counting. More...

template<typename CT = T, typename NCT = std::remove_const_t<T>>
	requires (std::is_const_v< CT > &&!std::is_same_v< CT, NCT >) GaudiHandle &operator
	Assignment operator for correct ref-counting. More...

virtual StatusCode	release (T *comp) const
	Release the component. More...

Public Member Functions inherited from GaudiHandleBase
const std::string &	typeAndName () const
	The full type and name: "type/name". More...

std::string	type () const
	The concrete component class name: the part before the '/'. More...

std::string	name () const
	The instance name: the part after the '/'. More...

bool	empty () const
	Check if the handle has been set to empty string (i.e. More...

void	setTypeAndName (std::string myTypeAndName)
	The component "type/name" string. More...

void	setName (std::string_view myName)
	Set the instance name (part after the '/') without changing the class type. More...

std::string	pythonPropertyClassName () const override
	Name of the componentType with "Handle" appended. More...

std::string	messageName () const
	name used for printing messages More...

std::string	pythonRepr () const override
	Python representation of handle, i.e. More...

Public Member Functions inherited from GaudiHandleInfo
virtual	~GaudiHandleInfo ()
	virtual destructor so that derived class destructor is called. More...

const std::string &	componentType () const

const std::string &	propertyName () const
	name as used in declareProperty(name,gaudiHandle) More...

void	setPropertyName (std::string propName)
	set name as used in declareProperty(name,gaudiHandle). More...

const std::string &	parentName () const
	The name of the parent. More...

Protected Member Functions
StatusCode	retrieve (T *&service) const override
	Do the real retrieval of the Service. More...

Protected Member Functions inherited from GaudiHandle< T >
	GaudiHandle (std::string myTypeAndName, std::string myComponentType, std::string myParentName)

Protected Member Functions inherited from GaudiHandleBase
	GaudiHandleBase (std::string myTypeAndName, std::string myComponentType, std::string myParentName)
	Create a handle ('smart pointer') to a gaudi component. More...

Protected Member Functions inherited from GaudiHandleInfo
	GaudiHandleInfo (std::string myComponentType, std::string myParentName)
	Some basic information and helper functions shared between various handles/arrays. More...

void	setComponentType (std::string componentType)
	The component type. More...

void	setParentName (std::string parent)
	The name of the parent. More...

Private Member Functions
SmartIF< ISvcLocator > &	serviceLocator () const

SmartIF< IMessageSvc > &	messageSvc () const

Private Attributes
SmartIF< ISvcLocator >	m_pSvcLocator

SmartIF< IMessageSvc >	m_pMessageSvc

Additional Inherited Members
Public Types inherited from GaudiHandleBase
using	PropertyType = GaudiHandleProperty

Detailed Description

template<class T>
class ServiceHandle< T >

Handle to be used in lieu of naked pointers to services. This allows better control through the framework of service loading and usage.

Author: Marti.nosp@m.n.Wo.nosp@m.udstr.nosp@m.a@ce.nosp@m.rn.ch

Definition at line 38 of file ServiceHandle.h.

Constructor & Destructor Documentation

◆ ServiceHandle() [1/2]

template<class T >

ServiceHandle< T >::ServiceHandle	(	const std::string &	serviceName,
		const std::string &	theParentName
	)

inline

Create a handle ('smart pointer') to a service.

The arguments are passed on to ServiceSvc, and have the same meaning:

Parameters

serviceName	name of the service
parentName	name of the parent Algorithm, AlgTool or Service. It is used for log printout at retrieve(), and for retrieving a thread-dependent service (if applicable)

Definition at line 47 of file ServiceHandle.h.

48 : GaudiHandle<T>( serviceName, "Service", theParentName ) {}

◆ ServiceHandle() [2/2]

template<class T >

template<std::derived_from< IProperty > OWNER>

ServiceHandle< T >::ServiceHandle	(	OWNER *	owner,
		std::string	PropName,
		const std::string &	svcName,
		std::string	doc = `""`
	)

inline

Autodeclaring constructor with property name, service type/name and documentation.

Note: the use of requires is required to avoid ambiguities

Definition at line 58 of file ServiceHandle.h.

       : ServiceHandle( svcName, owner->name() ) {
     auto p = owner->OWNER::PropertyHolderImpl::declareProperty( std::move( PropName ), *this, std::move( doc ) );
     p->template setOwnerType<OWNER>();
   }

Member Function Documentation

◆ get()

template<class T >

T* ServiceHandle< T >::get ( ) const

inline

Allow non const access to the service, even from a const handle...

Definition at line 77 of file ServiceHandle.h.

77 { return ::details::nonConst( GaudiHandle<T>::get() ); }

◆ initialize()

template<class T >

StatusCode ServiceHandle< T >::initialize	(	const std::string &	serviceName,
		const std::string &	theParentName
	)

inline

Definition at line 64 of file ServiceHandle.h.

                                                                                         {
  
     GaudiHandleBase::setTypeAndName( serviceName );
     GaudiHandleBase::setParentName( theParentName );
  
     return StatusCode::SUCCESS;
   }

◆ messageSvc()

template<class T >

SmartIF<IMessageSvc>& ServiceHandle< T >::messageSvc ( ) const

inlineprivate

Definition at line 106 of file ServiceHandle.h.

                                            { // not really const, because it may change m_pMessageSvc
     if ( !m_pMessageSvc ) {
       m_pMessageSvc = serviceLocator(); // default message service
       if ( !m_pMessageSvc ) {
         throw GaudiException( "Service [MessageSvc] not found", this->parentName(), StatusCode::FAILURE );
       }
     }
     return m_pMessageSvc;
   }

◆ operator*()

template<class T >

T& ServiceHandle< T >::operator* ( ) const

inline

Definition at line 81 of file ServiceHandle.h.

81 { return *::details::nonConst( GaudiHandle<T>::operator->() ); }

◆ operator->()

template<class T >

T* ServiceHandle< T >::operator-> ( ) const

inline

Allow non const access to the service, even from a const handle...

Definition at line 80 of file ServiceHandle.h.

80 { return ::details::nonConst( GaudiHandle<T>::operator->() ); }

◆ requires()

template<class T >

template<typename CT = T, typename NCT = std::remove_const_t<T>>

ServiceHandle< T >::requires ( std::is_const_v< CT > &&!std::is_same_v< CT, NCT > ) const &

inline

Copy constructor from a non const T to const T service handle.

Definition at line 52 of file ServiceHandle.h.

53 : GaudiHandle<CT>( other ) {}

◆ retrieve()

template<class T >

StatusCode ServiceHandle< T >::retrieve ( T *& service ) const

inlineoverrideprotected

Do the real retrieval of the Service.

Definition at line 85 of file ServiceHandle.h.

                                                     {
     const ServiceLocatorHelper helper( *serviceLocator(), GaudiHandleBase::messageName(), this->parentName() );
     if ( auto svc = helper.service<T>( GaudiHandleBase::typeAndName(), /* quiet = */ true, /* createIf = */ true ) ) {
       svc->addRef();
       service = svc.get();
       return StatusCode::SUCCESS;
     }
     return StatusCode::FAILURE;
   }

◆ serviceLocator()

template<class T >

SmartIF<ISvcLocator>& ServiceHandle< T >::serviceLocator ( ) const

inlineprivate

Definition at line 96 of file ServiceHandle.h.

                                                { // not really const, because it may change m_pSvcLocator
     if ( !m_pSvcLocator ) {
       m_pSvcLocator = Gaudi::svcLocator();
       if ( !m_pSvcLocator ) {
         throw GaudiException( "SvcLocator not found", "Core component not found", StatusCode::FAILURE );
       }
     }
     return m_pSvcLocator;
   }

Member Data Documentation

◆ m_pMessageSvc

template<class T >

SmartIF<IMessageSvc> ServiceHandle< T >::m_pMessageSvc

mutableprivate

Definition at line 117 of file ServiceHandle.h.

◆ m_pSvcLocator

template<class T >

SmartIF<ISvcLocator> ServiceHandle< T >::m_pSvcLocator

mutableprivate

Definition at line 116 of file ServiceHandle.h.

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

GaudiKernel/include/GaudiKernel/ServiceHandle.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class T> class ServiceHandle< T >

Constructor & Destructor Documentation

◆ ServiceHandle() [1/2]

◆ ServiceHandle() [2/2]

Member Function Documentation

◆ get()

◆ initialize()

◆ messageSvc()

◆ operator*()

◆ operator->()

◆ requires()

◆ retrieve()

◆ serviceLocator()

Member Data Documentation

◆ m_pMessageSvc

◆ m_pSvcLocator

template<class T>
class ServiceHandle< T >