| # Gaudi Framework, version v25r0 |

Home |  | Generated: Mon Feb 17 2014

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

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

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
GaudiHandleInfo Class Referenceabstract

`#include <GaudiHandle.h>`

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

## Public Member Functions
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 (const std::string &propName)
| set name as used in declareProperty(name,gaudiHandle).
const std::string & | parentName () const
| The name of the parent.
virtual const std::string | pythonPropertyClassName () const =0
| The python class name for the property in the genconf-generated configurables.
virtual const std::string | pythonRepr () const =0
| Python representation of handle, i.e.

## Protected Member Functions
| GaudiHandleInfo (const std::string &myComponentType, const std::string &myParentName)
| Some basic information and helper functions shared between various handles/arrays.

## Private Attributes
std::string | m_componentType
std::string | m_propertyName
std::string | m_parentName

## Detailed Description

Definition at line 14 of file GaudiHandle.h.

## Constructor & Destructor Documentation

GaudiHandleInfo::GaudiHandleInfo | ( | const std::string & | myComponentType,
|  | const std::string & | myParentName
| ) |  |
| inline protected

Some basic information and helper functions shared between various handles/arrays.

Parameters

  myComponentType,: | string indicating what type of component the handle is pointing to. For example: "PublicTool", "PrivateTool", "Service". This is used for printout and on the python side for type checking. On the python side there are classes with these names with "Handle" appended: PublicToolHandle,PrivateToolHandle,ServiceHandle
  myParentName,: | Name of the parent that has this handle as a member. Used in printout.

Definition at line 24 of file GaudiHandle.h.

: m_componentType(myComponentType), m_parentName(myParentName)
{}

virtual GaudiHandleInfo::~GaudiHandleInfo | ( |  | ) |
| inline virtual

virtual destructor so that derived class destructor is called.

Definition at line 29 of file GaudiHandle.h.

{}

## Member Function Documentation

const std::string& GaudiHandleInfo::componentType | ( |  | ) | const
| inline

Definition at line 33 of file GaudiHandle.h.

{
return m_componentType;
}

const std::string& GaudiHandleInfo::parentName | ( |  | ) | const
| inline

The name of the parent.

Definition at line 48 of file GaudiHandle.h.

{
return m_parentName;
}

const std::string& GaudiHandleInfo::propertyName | ( |  | ) | const
| inline

name as used in declareProperty(name,gaudiHandle)

Definition at line 38 of file GaudiHandle.h.

{
return m_propertyName;
}

virtual const std::string GaudiHandleInfo::pythonPropertyClassName | ( |  | ) | const
| pure virtual

The python class name for the property in the genconf-generated configurables.

The python class is defined in GaudiPython/python/GaudiHandles.py. To be implemented in derived class.

Implemented in GaudiHandleArrayBase, and GaudiHandleBase.

virtual const std::string GaudiHandleInfo::pythonRepr | ( |  | ) | const
| pure virtual

Python representation of handle, i.e.

python class name and argument. Can be used in the genconf-generated configurables. The corresponding python classes are defined in GaudiPython/GaudiHandles.py. To be implemented in derived class.

Implemented in GaudiHandleArrayBase, and GaudiHandleBase.

void GaudiHandleInfo::setPropertyName | ( | const std::string & | propName | ) |
| inline

set name as used in declareProperty(name,gaudiHandle).

Used in printout.

Definition at line 43 of file GaudiHandle.h.

{
m_propertyName = propName;
}

## Member Data Documentation

std::string GaudiHandleInfo::m_componentType
| private

Definition at line 67 of file GaudiHandle.h.

std::string GaudiHandleInfo::m_parentName
| private

Definition at line 69 of file GaudiHandle.h.

std::string GaudiHandleInfo::m_propertyName
| private

Definition at line 68 of file GaudiHandle.h.

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

- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v25r0/GaudiKernel/GaudiKernel/GaudiHandle.h