GaudiHandle< T > Class Template Reference

Handle to be used in lieu of naked pointers to gaudis. More...

#include <GaudiKernel/GaudiHandle.h>

Inheritance diagram for GaudiHandle< T >:

Collaboration diagram for GaudiHandle< T >:

Public Member Functions
template<typename CT = T, typename NCT = typename std::remove_const<T>::type>
	GaudiHandle (const GaudiHandle< NCT > &other, typename std::enable_if< std::is_const< CT >::value &&!std::is_same< CT, NCT >::value >::type *=nullptr)
	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 = typename std::remove_const<T>::type>
std::enable_if< std::is_const< CT >::value &&!std::is_same< CT, NCT >::value, GaudiHandle & >::type	operator= (const GaudiHandle< NCT > &other)
	Assignment operator for correct ref-counting. More...
GaudiHandle &	operator= (const GaudiHandle &other)
	Assignment operator for correct ref-counting. More...
StatusCode	retrieve () const
	Retrieve the component. More...
StatusCode	release () const
	Release the component. More...
bool	isValid () const
	Check if the handle is valid (try to retrive the object is not done yet). More...
	operator bool () const
	For testing if handle has component. More...
T *	get ()
	Return the wrapped pointer, not calling retrieve() if null. More...
std::add_const< T >::type *	get () const
	Return the wrapped pointer, not calling retrieve() if null. More...
bool	isSet () const
	True if the wrapped pointer is not null. More...
T &	operator* ()
T *	operator-> ()
std::add_const< T >::type &	operator* () const
std::add_const< T >::type *	operator-> () const
std::string	getDefaultType ()
	Helper function to get default type string from the class type. More...
std::string	getDefaultName ()
Public Member Functions inherited from GaudiHandleBase
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 (const std::string &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 ()=default
	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
	GaudiHandle (std::string myTypeAndName, std::string myComponentType, std::string myParentName)
virtual StatusCode	retrieve (T *&) const =0
	Retrieve the component. More...
virtual StatusCode	release (T *comp) const
	Release the component. More...
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 (const std::string &componentType)
	The component type. More...
void	setParentName (const std::string &parent)
	The name of the parent. More...

Private Member Functions
void	setDefaultTypeAndName ()
	Helper function to set default name and type. More...
void	setDefaultType ()
	Helper function to set default type from the class type T. More...
void	assertObject () const
	Load the pointer to the component. More...

Private Attributes
T *	m_pObject = nullptr

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

Detailed Description

template<class T>
class GaudiHandle< T >

Handle to be used in lieu of naked pointers to gaudis.

This allows better control through the framework of gaudi loading and usage. T is the type of the component interface (or concrete class).

Author

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

Definition at line 163 of file GaudiHandle.h.

Constructor & Destructor Documentation

template<class T>

GaudiHandle< T >::GaudiHandle ( std::string  myTypeAndName, std::string  myComponentType, std::string  myParentName  )

inlineprotected

Definition at line 168 of file GaudiHandle.h.

      : GaudiHandleBase( std::move( myTypeAndName ), std::move( myComponentType ), std::move( myParentName ) ) {}

template<class T>

template<typename CT = T, typename NCT = typename std::remove_const<T>::type>

GaudiHandle< T >::GaudiHandle ( const GaudiHandle< NCT > &  other, typename std::enable_if< std::is_const< CT >::value &&!std::is_same< CT, NCT >::value >::type *  = nullptr  )

inline

Copy constructor needed for correct ref-counting.

Definition at line 174 of file GaudiHandle.h.

      : GaudiHandleBase( other ) {
    m_pObject = other.get();
    if ( m_pObject ) ::details::nonConst( m_pObject )->addRef();
  }

template<class T>

GaudiHandle< T >::GaudiHandle ( const GaudiHandle< T > &  other )

inline

Copy constructor needed for correct ref-counting.

Definition at line 182 of file GaudiHandle.h.

                                          : GaudiHandleBase( other ) {
    m_pObject = other.m_pObject;
    if ( m_pObject ) ::details::nonConst( m_pObject )->addRef();
  }

Member Function Documentation

template<class T>

void GaudiHandle< T >::assertObject ( ) const

inlineprivate

Load the pointer to the component.

Do a retrieve if needed. Throw an exception if retrieval fails.

Definition at line 310 of file GaudiHandle.h.

                            { // not really const, because it may update m_pObject
    if ( UNLIKELY( !isValid() ) ) {
      throw GaudiException( "Failed to retrieve " + componentType() + ": " + typeAndName(),
                            componentType() + " retrieve", StatusCode::FAILURE );
    }
  }

template<class T>

T* GaudiHandle< T >::get ( )

inline

Return the wrapped pointer, not calling retrieve() if null.

Definition at line 248 of file GaudiHandle.h.

{ return m_pObject; }

template<class T>

std::add_const<T>::type* GaudiHandle< T >::get ( ) const

inline

Return the wrapped pointer, not calling retrieve() if null.

Definition at line 251 of file GaudiHandle.h.

{ return m_pObject; }

template<class T>

std::string GaudiHandle< T >::getDefaultName ( )

inline

Definition at line 281 of file GaudiHandle.h.

                             {
    const auto defName = GaudiHandleBase::type();
    return ( defName.empty() ? getDefaultType() : defName );
  }

template<class T>

std::string GaudiHandle< T >::getDefaultType ( )

inline

Helper function to get default type string from the class type.

Definition at line 279 of file GaudiHandle.h.

{ return System::typeinfoName( typeid( T ) ); }

template<class T>

bool GaudiHandle< T >::isSet ( ) const

inline

True if the wrapped pointer is not null.

Definition at line 254 of file GaudiHandle.h.

{ return get(); }

template<class T>

bool GaudiHandle< T >::isValid ( ) const

inline

Check if the handle is valid (try to retrive the object is not done yet).

Definition at line 235 of file GaudiHandle.h.

                       {
    // not really const, because it may update m_pObject
    return m_pObject || retrieve().isSuccess();
  }

template<class T>

GaudiHandle< T >::operator bool ( ) const

inline

For testing if handle has component.

Does retrieve() if needed. If this returns false, the component could not be retrieved.

Definition at line 242 of file GaudiHandle.h.

                        {
    // not really const, because it may update m_pObject
    return isValid();
  }

template<class T>

T& GaudiHandle< T >::operator* ( )

inline

Definition at line 256 of file GaudiHandle.h.

                 {
    assertObject();
    return *m_pObject;
  }

template<class T>

std::add_const<T>::type& GaudiHandle< T >::operator* ( ) const

inline

Definition at line 266 of file GaudiHandle.h.

                                                  {
    // not really const, because it may update m_pObject
    assertObject();
    return *m_pObject;
  }

template<class T>

T* GaudiHandle< T >::operator-> ( )

inline

Definition at line 261 of file GaudiHandle.h.

                  {
    assertObject();
    return m_pObject;
  }

template<class T>

std::add_const<T>::type* GaudiHandle< T >::operator-> ( ) const

inline

Definition at line 272 of file GaudiHandle.h.

                                                   {
    // not really const, because it may update m_pObject
    assertObject();
    return m_pObject;
  }

template<class T>

template<typename CT = T, typename NCT = typename std::remove_const<T>::type>

std::enable_if<std::is_const<CT>::value && !std::is_same<CT, NCT>::value, GaudiHandle&>::type GaudiHandle< T >::operator= ( const GaudiHandle< NCT > &  other )

inline

Assignment operator for correct ref-counting.

Definition at line 190 of file GaudiHandle.h.

                                             {
    GaudiHandleBase::operator=( other );
    // release any current tool
    release().ignore();
    m_pObject = other.get();
    // update ref-counting
    if ( m_pObject ) ::details::nonConst( m_pObject )->addRef();
    return *this;
  }

template<class T>

GaudiHandle& GaudiHandle< T >::operator= ( const GaudiHandle< T > &  other )

inline

Assignment operator for correct ref-counting.

Definition at line 201 of file GaudiHandle.h.

                                                     {
    GaudiHandleBase::operator=( other );
    // release any current tool
    release().ignore();
    m_pObject = other.m_pObject;
    // update ref-counting
    if ( m_pObject ) ::details::nonConst( m_pObject )->addRef();
    return *this;
  }

template<class T>

StatusCode GaudiHandle< T >::release ( ) const

inline

Release the component.

Definition at line 224 of file GaudiHandle.h.

                             {
    // not really const, because it updates m_pObject
    StatusCode sc = StatusCode::SUCCESS;
    if ( m_pObject ) {
      sc        = release( m_pObject );
      m_pObject = nullptr;
    }
    return sc;
  }

template<class T>

virtual StatusCode GaudiHandle< T >::release ( T *  comp ) const

inlineprotectedvirtual

Release the component.

Default implementation calls release() on the component. Can be overridden by the derived class if something else is needed.

Reimplemented in ToolHandle< T >, and ToolHandle< IThreadInitTool >.

Definition at line 292 of file GaudiHandle.h.

                                              { // not really const, because it updates m_pObject
    // const cast to support T being a const type
    ::details::nonConst( comp )->release();
    return StatusCode::SUCCESS;
  }

template<class T>

StatusCode GaudiHandle< T >::retrieve ( ) const

inline

Retrieve the component.

Release existing component if needed.

Definition at line 212 of file GaudiHandle.h.

                              {
    // not really const, because it updates m_pObject
    StatusCode sc = StatusCode::SUCCESS;
    if ( m_pObject && release().isFailure() ) { sc = StatusCode::FAILURE; }
    if ( sc && retrieve( m_pObject ).isFailure() ) {
      m_pObject = nullptr;
      sc        = StatusCode::FAILURE;
    }
    return sc;
  }

template<class T>

virtual StatusCode GaudiHandle< T >::retrieve ( T *&  ) const

protectedpure virtual

Retrieve the component.

To be implemented by the derived class. It will pass the pointer

Implemented in ToolHandle< T >, ToolHandle< IThreadInitTool >, ServiceHandle< T >, ServiceHandle< IToolSvc >, and ServiceHandle< IInterface >.

template<class T>

void GaudiHandle< T >::setDefaultType ( )

inlineprivate

Helper function to set default type from the class type T.

Definition at line 306 of file GaudiHandle.h.

{ GaudiHandleBase::setTypeAndName( getDefaultType() ); }

template<class T>

void GaudiHandle< T >::setDefaultTypeAndName ( )

inlineprivate

Helper function to set default name and type.

Definition at line 300 of file GaudiHandle.h.

                               {
    const std::string& myType = getDefaultType();
    GaudiHandleBase::setTypeAndName( myType + '/' + myType );
  }

Member Data Documentation

template<class T>

T* GaudiHandle< T >::m_pObject = nullptr

mutableprivate

Definition at line 321 of file GaudiHandle.h.

---

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

• GaudiKernel/GaudiKernel/GaudiHandle.h