GaudiHandleInfo Class Reference

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/GaudiHandle.h>

Inheritance diagram for GaudiHandleInfo:

Collaboration diagram for GaudiHandleInfo:

Public Member Functions
virtual	~GaudiHandleInfo ()
	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 (std::string componentType)
	The component type. More...
void	setParentName (std::string parent)
	The name of the parent. More...

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

Friends
std::ostream &	operator<< (std::ostream &os, const GaudiHandleInfo &handle)

Detailed Description

Definition at line 34 of file GaudiHandle.h.

Constructor & Destructor Documentation

GaudiHandleInfo()

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

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

~GaudiHandleInfo()

virtual GaudiHandleInfo::~GaudiHandleInfo ( )

inlinevirtual

virtual destructor so that derived class destructor is called.

Definition at line 52 of file GaudiHandle.h.

{}

Member Function Documentation

componentType()

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

inline

Definition at line 56 of file GaudiHandle.h.

{ return m_componentType; }

parentName()

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

inline

The name of the parent.

Definition at line 65 of file GaudiHandle.h.

{ return m_parentName; }

propertyName()

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

inline

name as used in declareProperty(name,gaudiHandle)

Definition at line 59 of file GaudiHandle.h.

{ return m_propertyName; }

pythonPropertyClassName()

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.

pythonRepr()

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.

setComponentType()

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

inlineprotected

The component type.

Definition at line 84 of file GaudiHandle.h.

{ m_componentType = std::move( componentType ); }

setParentName()

void GaudiHandleInfo::setParentName ( std::string  parent )

inlineprotected

The name of the parent.

Definition at line 87 of file GaudiHandle.h.

{ m_parentName = std::move( parent ); }

setPropertyName()

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

inline

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

Used in printout.

Definition at line 62 of file GaudiHandle.h.

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

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, const GaudiHandleInfo &  handle  )

friend

Definition at line 104 of file GaudiHandle.cpp.

                                                                        {
  std::string msg;
  const auto& propName = handle.propertyName();
  if ( !propName.empty() ) msg += propName + " = ";
  msg += handle.pythonRepr();
  os << msg;
  return os;
}

Member Data Documentation

m_componentType

std::string GaudiHandleInfo::m_componentType

private

Definition at line 93 of file GaudiHandle.h.

m_parentName

std::string GaudiHandleInfo::m_parentName

private

Definition at line 95 of file GaudiHandle.h.

m_propertyName

std::string GaudiHandleInfo::m_propertyName

private

Definition at line 94 of file GaudiHandle.h.

---

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

• GaudiKernel/include/GaudiKernel/GaudiHandle.h