PublicToolHandle< T > Class Template Reference

Helper class to construct ToolHandle instances for public tools via the auto registering constructor. More...

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

Inheritance diagram for PublicToolHandle< T >:

Collaboration diagram for PublicToolHandle< T >:

Public Member Functions
	PublicToolHandle (bool createIf=true)
	PublicToolHandle (const char *toolTypeAndName, bool createIf=true)
	PublicToolHandle (const std::string &toolTypeAndName, bool createIf=true)
template<typename CT = T, typename NCT = std::remove_const_t<T>> requires ( std::is_const_v<CT> && !std::is_same_v<CT, NCT> )
	PublicToolHandle (const PublicToolHandle< NCT > &other)
	Copy constructor from a non const T to const T tool handle.
template<std::derived_from< IProperty > OWNER>
	PublicToolHandle (OWNER *owner, std::string propName, std::string toolType, std::string doc="")
	Autodeclaring constructor with property propName, tool type/name and documentation.
Public Member Functions inherited from ToolHandle< T >
	ToolHandle (const IInterface *parent=nullptr, bool createIf=true)
	Constructor for a tool with default tool type and name.
template<typename CT = T, typename NCT = std::remove_const_t<T>> requires ( std::is_const_v<CT> && !std::is_same_v<CT, NCT> )
	ToolHandle (const ToolHandle< NCT > &other)
	Copy constructor from a non const T to const T tool handle.
	ToolHandle (const std::string &toolTypeAndName, const IInterface *parent=nullptr, bool createIf=true)
	Create a handle ('smart pointer') to a tool.
template<std::derived_from< IProperty > OWNER>
	ToolHandle (OWNER *owner, std::string propName, std::string toolType, std::string doc="")
	Autodeclaring constructor with property propName, tool type/name and documentation.
template<typename... Args>
	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.
StatusCode	retrieve (DisableTool sd) override
StatusCode	retrieve (EnableTool sd) override
StatusCode	release () const override
	Release the AlgTool.
StatusCode	retrieve (T *&algTool) const override
	Do the real retrieval of the AlgTool.
StatusCode	release (T *algTool) const override
	Do the real release of the AlgTool.
std::string	typeAndName () const override
std::add_const_t< T > *	get () const
T *	get ()
Public Member Functions inherited from BaseToolHandle
StatusCode	retrieve (IAlgTool *&tool) const
const IAlgTool *	get () const
IAlgTool *	get ()
bool	isEnabled () const
	Helper to check if the ToolHandle should be retrieved.
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< T >
template<typename CT = T, typename NCT = std::remove_const_t<T>> requires ( std::is_const_v<CT> && !std::is_same_v<CT, NCT> )
	GaudiHandle (const GaudiHandle< NCT > &other)
	Copy constructor needed for correct ref-counting.
	GaudiHandle (const GaudiHandle &other)
	Copy constructor needed for correct ref-counting.
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= (const GaudiHandle< NCT > &other)
	Assignment operator for correct ref-counting.
GaudiHandle &	operator= (const GaudiHandle &other)
	Assignment operator for correct ref-counting.
StatusCode	retrieve () const
	Retrieve the component.
StatusCode	release () const
	Release the component.
bool	isValid () const
	Check if the handle is valid (try to retrive the object is not done yet).
	operator bool () const
	For testing if handle has component.
T *	get ()
	Return the wrapped pointer, not calling retrieve() if null.
std::add_const_t< T > *	get () const
	Return the wrapped pointer, not calling retrieve() if null.
bool	isSet () const
	True if the wrapped pointer is not null.
T &	operator* ()
T *	operator-> ()
std::add_const_t< T > &	operator* () const
std::add_const_t< T > *	operator-> () const
std::string	getDefaultType ()
	Helper function to get default type string from the class type.
std::string	getDefaultName ()
Public Member Functions inherited from GaudiHandleBase
const std::string &	typeAndName () const
	The full type and name: "type/name".
std::string	type () const
	The concrete component class name: the part before the '/'.
std::string	name () const
	The instance name: the part after the '/'.
bool	empty () const
	Check if the handle has been set to empty string (i.e.
void	setTypeAndName (std::string myTypeAndName)
	The component "type/name" string.
void	setName (std::string_view myName)
	Set the instance name (part after the '/') without changing the class type.
std::string	pythonPropertyClassName () const override
	Name of the componentType with "Handle" appended.
std::string	messageName () const
	name used for printing messages
std::string	pythonRepr () const override
	Python representation of handle, i.e.
Public Member Functions inherited from GaudiHandleInfo
virtual	~GaudiHandleInfo ()
	virtual destructor so that derived class destructor is called.
const std::string &	componentType () const
const std::string &	propertyName () const
	name as used in declareProperty(name,gaudiHandle)
void	setPropertyName (std::string propName)
	set name as used in declareProperty(name,gaudiHandle).
const std::string &	parentName () const
	The name of the parent.

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< T >
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)
Protected Member Functions inherited from ToolHandleInfo
	ToolHandleInfo (const IInterface *parent=nullptr, bool createIf=true)
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.
Protected Member Functions inherited from GaudiHandleInfo
	GaudiHandleInfo (std::string myComponentType, std::string myParentName)
	Some basic information and helper functions shared between various handles/arrays.
void	setComponentType (std::string componentType)
	The component type.
void	setParentName (std::string parent)
	The name of the parent.
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<class T>
class PublicToolHandle< T >

Helper class to construct ToolHandle instances for public tools via the auto registering constructor.

Definition at line 351 of file ToolHandle.h.

Constructor & Destructor Documentation

PublicToolHandle() [1/5]

template<class T>

PublicToolHandle< T >::PublicToolHandle ( bool createIf = true )

inline

Definition at line 353 of file ToolHandle.h.

: ToolHandle<T>( nullptr, createIf ) {}

PublicToolHandle() [2/5]

template<class T>

PublicToolHandle< T >::PublicToolHandle ( const char * toolTypeAndName, bool createIf = true )

inline

Definition at line 354 of file ToolHandle.h.

      : PublicToolHandle{ std::string{ toolTypeAndName }, createIf } {}

PublicToolHandle() [3/5]

template<class T>

PublicToolHandle< T >::PublicToolHandle ( const std::string & toolTypeAndName, bool createIf = true )

inline

Definition at line 356 of file ToolHandle.h.

      : ToolHandle<T>( toolTypeAndName, nullptr, createIf ) {}

PublicToolHandle() [4/5]

template<class T>

template<typename CT = T, typename NCT = std::remove_const_t<T>>
requires ( std::is_const_v<CT> && !std::is_same_v<CT, NCT> )

PublicToolHandle< T >::PublicToolHandle ( const PublicToolHandle< NCT > & other )

inline

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

Definition at line 362 of file ToolHandle.h.

      : ToolHandle<T>( static_cast<const ToolHandle<NCT>&>( other ) ) {}

PublicToolHandle() [5/5]

template<class T>

template<std::derived_from< IProperty > OWNER>

PublicToolHandle< T >::PublicToolHandle ( OWNER * owner, std::string propName, std::string toolType, std::string doc = "" )

inline

Autodeclaring constructor with property propName, tool type/name and documentation.

Note

the use of requires is required to avoid ambiguities

Definition at line 368 of file ToolHandle.h.

      : PublicToolHandle() {
    // convert name and type to a valid type/name string
    // - if type does not contain '/' use type/type
    // - otherwise type is already a type/name string
    if ( !toolType.empty() and toolType.find( '/' ) == std::string::npos ) { toolType += '/' + toolType; }
    owner->declareTool( *this, std::move( toolType ) ).ignore();
    auto p = owner->OWNER::PropertyHolderImpl::declareProperty( std::move( propName ), *this, std::move( doc ) );
    p->template setOwnerType<OWNER>();
  }

---

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

• GaudiKernel/include/GaudiKernel/ToolHandle.h