BaseToolHandle Class Reference

#include <GaudiKernel/ToolHandle.h>

Inheritance diagram for BaseToolHandle:

Collaboration diagram for BaseToolHandle:

Public Member Functions
StatusCode	retrieve (IAlgTool *&tool) const
virtual StatusCode	retrieve () const =0
virtual StatusCode	retrieve (DisableTool sd)=0
virtual StatusCode	retrieve (EnableTool sd)=0
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

Protected Member Functions
	BaseToolHandle (const IInterface *parent=nullptr, bool createIf=true)
virtual StatusCode	i_retrieve (IAlgTool *&) const =0
virtual const IAlgTool *	getAsIAlgTool () const =0
virtual IAlgTool *	getAsIAlgTool ()=0
Protected Member Functions inherited from ToolHandleInfo
	ToolHandleInfo (const IInterface *parent=nullptr, bool createIf=true)

Protected Attributes
bool	m_enabled = true
Protected Attributes inherited from ToolHandleInfo
const IInterface *	m_parent = nullptr
bool	m_createIf { true }

Additional Inherited Members
Static Public Member Functions inherited from ToolHandleInfo
static std::string	toolComponentType (const IInterface *parent)
static std::string	toolParentName (const IInterface *parent)

Detailed Description

Non-templated base class for actual ToolHandle<T>. Defines the interface for the management of ToolHandles in the Algorithms and Tools

Author

Daniel Funke danie.nosp@m.l.fu.nosp@m.nke@c.nosp@m.ern..nosp@m.ch

Definition at line 80 of file ToolHandle.h.

Constructor & Destructor Documentation

BaseToolHandle()

BaseToolHandle::BaseToolHandle ( const IInterface *  parent = nullptr, bool  createIf = true  )

inlineprotected

Definition at line 83 of file ToolHandle.h.

: ToolHandleInfo( parent, createIf ) {}

Member Function Documentation

disable()

void BaseToolHandle::disable ( )

inline

Definition at line 109 of file ToolHandle.h.

{ m_enabled = false; }

enable()

void BaseToolHandle::enable ( )

inline

Definition at line 107 of file ToolHandle.h.

{ m_enabled = true; }

get() [1/2]

IAlgTool* BaseToolHandle::get ( )

inline

Definition at line 96 of file ToolHandle.h.

{ return getAsIAlgTool(); }

get() [2/2]

const IAlgTool* BaseToolHandle::get ( ) const

inline

Definition at line 94 of file ToolHandle.h.

{ return getAsIAlgTool(); }

getAsIAlgTool() [1/2]

virtual const IAlgTool* BaseToolHandle::getAsIAlgTool ( ) const

protectedpure virtual

Implemented in ToolHandle< T >.

getAsIAlgTool() [2/2]

virtual IAlgTool* BaseToolHandle::getAsIAlgTool ( )

protectedpure virtual

Implemented in ToolHandle< T >, ToolHandle< IWrongTool >, ToolHandle< IMyTool >, ToolHandle< IAlgTool >, ToolHandle< Gaudi::Tests::Histograms::Directories::HistoGroupsTool >, ToolHandle< GaudiTesting::ITestTool >, ToolHandle< Gaudi::TestSuite::FloatTool >, ToolHandle< IThreadInitTool >, ToolHandle< const IMyTool >, ToolHandle< IWrongTool >, ToolHandle< IMyTool >, ToolHandle< IAlgTool >, ToolHandle< Gaudi::Tests::Histograms::Directories::HistoGroupsTool >, ToolHandle< GaudiTesting::ITestTool >, ToolHandle< Gaudi::TestSuite::FloatTool >, ToolHandle< IThreadInitTool >, and ToolHandle< const IMyTool >.

i_retrieve()

virtual StatusCode BaseToolHandle::i_retrieve ( IAlgTool *&  ) const

protectedpure virtual

Implemented in ToolHandle< T >, ToolHandle< IWrongTool >, ToolHandle< IMyTool >, ToolHandle< IAlgTool >, ToolHandle< Gaudi::Tests::Histograms::Directories::HistoGroupsTool >, ToolHandle< GaudiTesting::ITestTool >, ToolHandle< Gaudi::TestSuite::FloatTool >, ToolHandle< IThreadInitTool >, and ToolHandle< const IMyTool >.

isEnabled()

bool BaseToolHandle::isEnabled ( ) const

inline

Helper to check if the ToolHandle should be retrieved.

Definition at line 101 of file ToolHandle.h.

                         {
    // the handle is considered enabled if the type/name is valid and the
    // enabled flag was set to true, or it was already retrieved
    return ( m_enabled && !typeAndName().empty() ) || get();
  }

retrieve() [1/4]

virtual StatusCode BaseToolHandle::retrieve ( ) const

pure virtual

Implemented in ToolHandle< Gaudi::Interface::Bind::IBinder< IFace > >, and ToolHandle< T >.

retrieve() [2/4]

virtual StatusCode BaseToolHandle::retrieve ( DisableTool  sd )

pure virtual

Implemented in ToolHandle< T >, ToolHandle< IWrongTool >, ToolHandle< IMyTool >, ToolHandle< IAlgTool >, ToolHandle< Gaudi::Tests::Histograms::Directories::HistoGroupsTool >, ToolHandle< GaudiTesting::ITestTool >, ToolHandle< Gaudi::TestSuite::FloatTool >, ToolHandle< IThreadInitTool >, and ToolHandle< const IMyTool >.

retrieve() [3/4]

virtual StatusCode BaseToolHandle::retrieve ( EnableTool  sd )

pure virtual

Implemented in ToolHandle< T >, ToolHandle< IWrongTool >, ToolHandle< IMyTool >, ToolHandle< IAlgTool >, ToolHandle< Gaudi::Tests::Histograms::Directories::HistoGroupsTool >, ToolHandle< GaudiTesting::ITestTool >, ToolHandle< Gaudi::TestSuite::FloatTool >, ToolHandle< IThreadInitTool >, and ToolHandle< const IMyTool >.

retrieve() [4/4]

StatusCode BaseToolHandle::retrieve ( IAlgTool *&  tool ) const

inline

Definition at line 88 of file ToolHandle.h.

{ return i_retrieve( tool ); }

setEnabled()

bool BaseToolHandle::setEnabled ( bool  flag )

inline

Definition at line 111 of file ToolHandle.h.

{ return std::exchange( m_enabled, flag ); }

typeAndName()

virtual std::string BaseToolHandle::typeAndName ( ) const

pure virtual

Implemented in ToolHandle< T >.

Member Data Documentation

m_enabled

bool BaseToolHandle::m_enabled = true

protected

Definition at line 118 of file ToolHandle.h.

---

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

• GaudiKernel/include/GaudiKernel/ToolHandle.h