| The Gaudi Framework v29r1 (5cd95fa2)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ToolHandleInfo Class Reference

General info and helper functions for toolhandles and arrays. More...

`#include <GaudiKernel/ToolHandle.h>`

Inheritance diagram for ToolHandleInfo:
[legend]
Collaboration diagram for ToolHandleInfo:
[legend]

## Public Member Functions
virtual | ~ToolHandleInfo ()=default
bool | isPublic () const noexcept
bool | createIf () const noexcept
const IInterface * | parent () const noexcept

## Static Public Member Functions
static std::string | toolComponentType (const IInterface *parent)
static std::string | toolParentName (const IInterface *parent)

## Protected Member Functions
| ToolHandleInfo (const IInterface *parent=nullptr, bool createIf=true)

## Protected Attributes
const IInterface * | m_parent = nullptr
bool | m_createIf {true}

## Detailed Description

General info and helper functions for toolhandles and arrays.

Definition at line 25 of file ToolHandle.h.

## Constructor & Destructor Documentation

ToolHandleInfo::ToolHandleInfo | ( | const IInterface * | parent = `nullptr`,
|  | bool | createIf = `true`
| ) |  |
| inline protected

Definition at line 29 of file ToolHandle.h.

30 : m_parent( parent ), m_createIf( createIf )
31 {
32 }
ToolHandleInfo::m_parent
const IInterface * m_parent
Definition: ToolHandle.h:56
ToolHandleInfo::m_createIf
bool m_createIf
Definition: ToolHandle.h:57
ToolHandleInfo::createIf
bool createIf() const noexcept
Definition: ToolHandle.h:39

virtual ToolHandleInfo::~ToolHandleInfo | ( |  | ) |
| virtual default

## Member Function Documentation

bool ToolHandleInfo::createIf | ( |  | ) | const
| inline noexcept

Definition at line 39 of file ToolHandle.h.

39 { return m_createIf; }
ToolHandleInfo::m_createIf
bool m_createIf
Definition: ToolHandle.h:57

bool ToolHandleInfo::isPublic | ( |  | ) | const
| inline noexcept

Definition at line 37 of file ToolHandle.h.

37 { return !m_parent; }
ToolHandleInfo::m_parent
const IInterface * m_parent
Definition: ToolHandle.h:56

const IInterface* ToolHandleInfo::parent | ( |  | ) | const
| inline noexcept

Definition at line 41 of file ToolHandle.h.

41 { return m_parent; }
ToolHandleInfo::m_parent
const IInterface * m_parent
Definition: ToolHandle.h:56

static std::string ToolHandleInfo::toolComponentType | ( | const IInterface * | parent | ) |
| inline static

Definition at line 47 of file ToolHandle.h.

47 { return parent ? "PrivateTool" : "PublicTool"; }

static std::string ToolHandleInfo::toolParentName | ( | const IInterface * | parent | ) |
| inline static

Definition at line 49 of file ToolHandle.h.

50 {
51 auto* pNamed = ( parent ? dynamic_cast<const INamedInterface*>( parent ) : nullptr );
52 return ( !parent ? "ToolSvc" : ( pNamed ? pNamed->name() : "" ) );
53 }
ToolHandleInfo::parent
const IInterface * parent() const noexcept
Definition: ToolHandle.h:41
INamedInterface
IInterface compliant class extending IInterface with the name() method.
Definition: INamedInterface.h:15

## Member Data Documentation

bool ToolHandleInfo::m_createIf {true}
| protected

Definition at line 57 of file ToolHandle.h.

const IInterface* ToolHandleInfo::m_parent = nullptr
| protected

Definition at line 56 of file ToolHandle.h.

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

- GaudiKernel/GaudiKernel/ToolHandle.h