ToolHandle< Gaudi::Interface::Bind::IBinder< IFace > > Class Template Reference

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/ToolHandle.h>

Inheritance diagram for ToolHandle< Gaudi::Interface::Bind::IBinder< IFace > >:

Collaboration diagram for ToolHandle< Gaudi::Interface::Bind::IBinder< IFace > >:

Public Member Functions
StatusCode	retrieve () const override
auto	bind (const EventContext &ctx) const
Public Member Functions inherited from ToolHandle< IAlgTool >
	ToolHandle (const IInterface *parent=nullptr, bool createIf=true)
	Constructor for a tool with default tool type and name. More...
	ToolHandle (const ToolHandle< NCT > &other)
	Copy constructor from a non const T to const T tool handle. More...
	ToolHandle (const std::string &toolTypeAndName, const IInterface *parent=nullptr, bool createIf=true)
	Create a handle ('smart pointer') to a tool. More...
	ToolHandle (OWNER *owner, std::string propName, std::string toolType, std::string doc="")
	Autodeclaring constructor with property propName, tool type/name and documentation. More...
	ToolHandle (std::tuple< Args... > &&args)
StatusCode	initialize (const std::string &toolTypeAndName, const IInterface *parent=nullptr, bool createIf=true)
StatusCode	retrieve () const override
	Retrieve the AlgTool. More...
StatusCode	retrieve (DisableTool sd) override
StatusCode	retrieve (EnableTool sd) override
StatusCode	retrieve (IAlgTool *&algTool) const override
	Do the real retrieval of the AlgTool. More...
StatusCode	release () const
	Release the AlgTool. More...
StatusCode	release (IAlgTool *algTool) const override
	Do the real release of the AlgTool. More...
std::string	typeAndName () const override
std::add_const_t< IAlgTool > *	get () const
IAlgTool *	get ()
Public Member Functions inherited from BaseToolHandle
StatusCode	retrieve (IAlgTool *&tool) const
const IAlgTool *	get () const
IAlgTool *	get ()
virtual std::string	typeAndName () const =0
bool	isEnabled () const
	Helper to check if the ToolHandle should be retrieved. More...
void	enable ()
void	disable ()
bool	setEnabled (bool flag)
Public Member Functions inherited from ToolHandleInfo
virtual	~ToolHandleInfo ()=default
bool	isPublic () const noexcept
bool	createIf () const noexcept
const IInterface *	parent () const noexcept
Public Member Functions inherited from GaudiHandle< IAlgTool >
	GaudiHandle (const GaudiHandle< NCT > &other, std::enable_if_t< std::is_const_v< CT > &&!std::is_same_v< CT, NCT >> *=nullptr)
	Copy constructor needed for correct ref-counting. More...
	GaudiHandle (const GaudiHandle &other)
	Copy constructor needed for correct ref-counting. More...
std::enable_if_t< std::is_const_v< CT > &&!std::is_same_v< CT, NCT >, GaudiHandle & >	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...
IAlgTool *	get ()
	Return the wrapped pointer, not calling retrieve() if null. More...
std::add_const_t< IAlgTool > *	get () const
	Return the wrapped pointer, not calling retrieve() if null. More...
bool	isSet () const
	True if the wrapped pointer is not null. More...
IAlgTool &	operator* ()
std::add_const_t< IAlgTool > &	operator* () const
IAlgTool *	operator-> ()
std::add_const_t< IAlgTool > *	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 (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 ()=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...

Private Attributes
void *	m_ptr = nullptr
Gaudi::Interface::Bind::Box< IFace >(*	m_bind )(void const *, const EventContext &) = nullptr

Additional Inherited Members
Public Types inherited from GaudiHandleBase
using	PropertyType = GaudiHandleProperty
Static Public Member Functions inherited from ToolHandleInfo
static std::string	toolComponentType (const IInterface *parent)
static std::string	toolParentName (const IInterface *parent)
Protected Member Functions inherited from ToolHandle< IAlgTool >
const IAlgTool *	getAsIAlgTool () const override
IAlgTool *	getAsIAlgTool () override
StatusCode	i_retrieve (IAlgTool *&algTool) const override
Protected Member Functions inherited from BaseToolHandle
	BaseToolHandle (const IInterface *parent=nullptr, bool createIf=true)
virtual const IAlgTool *	getAsIAlgTool () const =0
Protected Member Functions inherited from ToolHandleInfo
	ToolHandleInfo (const IInterface *parent=nullptr, bool createIf=true)
Protected Member Functions inherited from GaudiHandle< IAlgTool >
	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...
Protected Attributes inherited from BaseToolHandle
bool	m_enabled = true
Protected Attributes inherited from ToolHandleInfo
const IInterface *	m_parent = nullptr
bool	m_createIf { true }

Detailed Description

template<typename IFace>
class ToolHandle< Gaudi::Interface::Bind::IBinder< IFace > >

Definition at line 308 of file ToolHandle.h.

Member Function Documentation

bind()

template<typename IFace >

auto ToolHandle< Gaudi::Interface::Bind::IBinder< IFace > >::bind ( const EventContext &  ctx ) const

inline

Definition at line 344 of file ToolHandle.h.

                                             {
    if ( !m_bind || !m_ptr ) {
      throw GaudiException{ "request bind on toolhandle which was not (successfully) 'retrieved'", __PRETTY_FUNCTION__,
                            StatusCode::FAILURE };
    }
    return ( *m_bind )( m_ptr, ctx );
  }

retrieve()

template<typename IFace >

StatusCode ToolHandle< Gaudi::Interface::Bind::IBinder< IFace > >::retrieve ( ) const

inlineoverridevirtual

Implements BaseToolHandle.

Definition at line 316 of file ToolHandle.h.

                                       {
    // FIXME: why is `retrieve` const????
    auto self = const_cast<ToolHandle<Gaudi::Interface::Bind::IBinder<IFace>>*>( this );
 
    return ToolHandle<IAlgTool>::retrieve().andThen( [&] {
      const IAlgTool* tool = get();
      assert( tool != nullptr ); // retrieve was succesfull, so get() better return something valid!
      return const_cast<IAlgTool*>( tool )
          ->queryInterface( IFace::interfaceID(), &( self->m_ptr ) )
          .andThen( [&] {
            // TODO: what happens to the refCount?
            self->m_bind = []( const void* ptr, const EventContext& ) {
              return Gaudi::Interface::Bind::Box<IFace>( static_cast<IFace const*>( ptr ) );
            };
          } )
          .orElse( [&]() {
            return const_cast<IAlgTool*>( tool )
                ->queryInterface( Gaudi::Interface::Bind::IBinder<IFace>::interfaceID(), &( self->m_ptr ) )
                .andThen( [&] {
                  // TODO: what happens to the refCount?
                  self->m_bind = []( const void* ptr, const EventContext& ctx ) {
                    return static_cast<Gaudi::Interface::Bind::IBinder<IFace> const*>( ptr )->bind( ctx );
                  };
                } );
          } );
    } );
  }

Member Data Documentation

m_bind

template<typename IFace >

Gaudi::Interface::Bind::Box<IFace>( * ToolHandle< Gaudi::Interface::Bind::IBinder< IFace > >::m_bind) (void const *, const EventContext &) = nullptr

private

Definition at line 310 of file ToolHandle.h.

m_ptr

template<typename IFace >

void* ToolHandle< Gaudi::Interface::Bind::IBinder< IFace > >::m_ptr = nullptr

private

Definition at line 310 of file ToolHandle.h.

---

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

• GaudiKernel/include/GaudiKernel/ToolHandle.h