#include </scratch/z5/marcocle/GaudiDocs/lhcb-release/996/GAUDI/GAUDI_v26r4/InstallArea/x86_64-slc6-gcc48-opt/include/GaudiKernel/GaudiHandle.h>

Inheritance diagram for GaudiHandleInfo:

[legend]

Collaboration diagram for GaudiHandleInfo:

[legend]

Public Member Functions
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...

virtual std::string	pythonPropertyClassName () const =0
	The python class name for the property in the genconf-generated configurables. More...

virtual std::string	pythonRepr () const =0
	Python representation of handle, i.e. More...

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...

virtual std::string	pythonPropertyClassName () const =0
	The python class name for the property in the genconf-generated configurables. More...

virtual std::string	pythonRepr () const =0
	Python representation of handle, i.e. More...

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

	GaudiHandleInfo (std::string myComponentType, std::string myParentName)
	Some basic information and helper functions shared between various handles/arrays. More...

Private Attributes
std::string	m_componentType

std::string	m_propertyName

std::string	m_parentName

Detailed Description

Definition at line 15 of file GaudiHandle.h.

Constructor & Destructor Documentation

GaudiHandleInfo::GaudiHandleInfo	(	std::string	myComponentType,
		std::string	myParentName
	)

inlineprotected

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 25 of file GaudiHandle.h.

26 : m_componentType(std::move(myComponentType)), m_parentName(std::move(myParentName))

27 {}

GaudiHandleInfo::m_componentType

std::string m_componentType

Definition: GaudiHandle.h:68

GaudiHandleInfo::m_parentName

std::string m_parentName

Definition: GaudiHandle.h:70

virtual GaudiHandleInfo::~GaudiHandleInfo ( )

virtualdefault

virtual destructor so that derived class destructor is called.

GaudiHandleInfo::GaudiHandleInfo	(	std::string	myComponentType,
		std::string	myParentName
	)

inlineprotected

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 25 of file GaudiHandle.h.

26 : m_componentType(std::move(myComponentType)), m_parentName(std::move(myParentName))

27 {}

GaudiHandleInfo::m_componentType

std::string m_componentType

Definition: GaudiHandle.h:68

GaudiHandleInfo::m_parentName

std::string m_parentName

Definition: GaudiHandle.h:70

virtual GaudiHandleInfo::~GaudiHandleInfo ( )

virtualdefault

virtual destructor so that derived class destructor is called.

Member Function Documentation

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

inline

Definition at line 34 of file GaudiHandle.h.

                                          {
      return m_componentType;
   }

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

inline

Definition at line 34 of file GaudiHandle.h.

                                          {
      return m_componentType;
   }

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

inline

The name of the parent.

Definition at line 49 of file GaudiHandle.h.

                                       {
     return m_parentName;
   }

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

inline

The name of the parent.

Definition at line 49 of file GaudiHandle.h.

                                       {
     return m_parentName;
   }

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

inline

name as used in declareProperty(name,gaudiHandle)

Definition at line 39 of file GaudiHandle.h.

                                         {
      return m_propertyName;
   }

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

inline

name as used in declareProperty(name,gaudiHandle)

Definition at line 39 of file GaudiHandle.h.

                                         {
      return m_propertyName;
   }

virtual 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, GaudiHandleArrayBase, GaudiHandleBase, and GaudiHandleBase.

virtual 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, GaudiHandleArrayBase, GaudiHandleBase, and GaudiHandleBase.

virtual 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, GaudiHandleArrayBase, GaudiHandleBase, and GaudiHandleBase.

virtual 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, GaudiHandleArrayBase, GaudiHandleBase, and GaudiHandleBase.

void GaudiHandleInfo::setPropertyName ( std::string propName )

inline

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

Used in printout.

Definition at line 44 of file GaudiHandle.h.

                                              {
     m_propertyName = std::move(propName);
   }

void GaudiHandleInfo::setPropertyName ( std::string propName )

inline

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

Used in printout.

Definition at line 44 of file GaudiHandle.h.

                                              {
     m_propertyName = std::move(propName);
   }

Member Data Documentation

std::string GaudiHandleInfo::m_componentType

private

Definition at line 68 of file GaudiHandle.h.

std::string GaudiHandleInfo::m_parentName

private

Definition at line 70 of file GaudiHandle.h.

std::string GaudiHandleInfo::m_propertyName

private

Definition at line 69 of file GaudiHandle.h.

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

InstallArea/x86_64-slc6-gcc48-opt/include/GaudiKernel/GaudiHandle.h

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation