#include <GaudiKernel/GaudiHandle.h>

Inheritance diagram for GaudiHandleInfo:

[legend]

Collaboration diagram for GaudiHandleInfo:

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

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

void	setComponentType (const std::string &componentType)
	The component type. More...

void	setParentName (const std::string &parent)
	The name of the parent. More...

Private Attributes
std::string	m_componentType

std::string	m_propertyName

std::string	m_parentName

Detailed Description

Definition at line 16 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 27 of file GaudiHandle.h.

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

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

38 { return m_componentType; }

GaudiHandleInfo::m_componentType

std::string m_componentType

Definition: GaudiHandle.h:71

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

inline

The name of the parent.

Definition at line 47 of file GaudiHandle.h.

47 { return m_parentName; }

GaudiHandleInfo::m_parentName

std::string m_parentName

Definition: GaudiHandle.h:73

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

inline

name as used in declareProperty(name,gaudiHandle)

Definition at line 41 of file GaudiHandle.h.

41 { return m_propertyName; }

GaudiHandleInfo::m_propertyName

std::string m_propertyName

Definition: GaudiHandle.h:72

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

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

inlineprotected

The component type.

Definition at line 62 of file GaudiHandle.h.

62 { m_componentType = componentType; }

GaudiHandleInfo::m_componentType

std::string m_componentType

Definition: GaudiHandle.h:71

GaudiHandleInfo::componentType

const std::string & componentType() const

Definition: GaudiHandle.h:38