GaudiHandleArrayBase Class Reference

Base class of array's of various gaudihandles. More...

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

Inheritance diagram for GaudiHandleArrayBase:

Collaboration diagram for GaudiHandleArrayBase:

Public Types
using	PropertyType = GaudiHandleArrayProperty
typedef std::vector< GaudiHandleBase * >	BaseHandleArray
typedef std::vector< const GaudiHandleBase * >	ConstBaseHandleArray

Public Member Functions
bool	setTypesAndNames (const std::vector< std::string > &myTypesAndNamesList)
	Set the array of handles from list of "type/name" strings in <myTypesAndNamesList>.
const std::vector< std::string >	typesAndNames () const
	Return a vector with "type/name" strings of all handles in the array.
const std::vector< std::string >	types () const
	Return a vector with "type" strings of all handles in the array.
const std::vector< std::string >	names () const
	Return a vector with "type/name" strings of all handles in the array.
const std::vector< std::string >	getBaseInfos (auto(GaudiHandleBase::*pMemFunc)() const) const
	Helper function to get a vector of strings filled with the return value of each tool of a member function if GaudiHandleBase.
std::string	pythonPropertyClassName () const override
	Name of the componentType with "HandleArray" appended.
std::string	pythonRepr () const override
	Python representation of array of handles, i.e.
virtual bool	push_back (const std::string &myHandleTypeAndName)=0
	Add a handle to the array with "type/name" given in <myHandleTypeAndName>.
virtual void	clear ()=0
	Clear the list of handles.
virtual bool	empty () const =0
	Return whether the list of tools is empty.
virtual ConstBaseHandleArray	getBaseArray () const =0
	Get a read-only vector of const GaudiHandleBase* pointing to the real handles.
virtual BaseHandleArray	getBaseArray ()=0
	Get a read-write vector of GaudiHandleBase* pointing to the real handles.
virtual StatusCode	retrieve ()=0
	Retrieve all tools.
virtual StatusCode	release ()=0
	Release all tools.
virtual bool	retrieved () const =0
	To be able to tell if Array was ever retreived.
Public Member Functions inherited from GaudiHandleInfo
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 (std::string propName)
	set name as used in declareProperty(name,gaudiHandle).
const std::string &	parentName () const
	The name of the parent.

Protected Member Functions
	GaudiHandleArrayBase (std::string myComponentType, std::string myParentName)
Protected Member Functions inherited from GaudiHandleInfo
	GaudiHandleInfo (std::string myComponentType, std::string myParentName)
	Some basic information and helper functions shared between various handles/arrays.
void	setComponentType (std::string componentType)
	The component type.
void	setParentName (std::string parent)
	The name of the parent.

Detailed Description

Base class of array's of various gaudihandles.

Used in communication with GaudiHandleArrayProperty. For that purpose is has some pure virtual functions. This is a non-templated class to one Property can handle all kinds of concrete handles.

Definition at line 334 of file GaudiHandle.h.

Member Typedef Documentation

BaseHandleArray

typedef std::vector<GaudiHandleBase*> GaudiHandleArrayBase::BaseHandleArray

Definition at line 341 of file GaudiHandle.h.

ConstBaseHandleArray

typedef std::vector<const GaudiHandleBase*> GaudiHandleArrayBase::ConstBaseHandleArray

Definition at line 342 of file GaudiHandle.h.

PropertyType

using GaudiHandleArrayBase::PropertyType = GaudiHandleArrayProperty

Definition at line 340 of file GaudiHandle.h.

Constructor & Destructor Documentation

GaudiHandleArrayBase()

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

inlineprotected

Definition at line 336 of file GaudiHandle.h.

      : GaudiHandleInfo( std::move( myComponentType ), std::move( myParentName ) ) {}

Member Function Documentation

clear()

virtual void GaudiHandleArrayBase::clear ( )

pure virtual

Clear the list of handles.

Implemented in GaudiHandleArray

Implemented in GaudiHandleArray< T >, GaudiHandleArray< ServiceHandle< T > >, GaudiHandleArray< ToolHandle< IMyTool > >, GaudiHandleArray< ToolHandle< IThreadInitTool > >, and GaudiHandleArray< ToolHandle< T > >.

empty()

virtual bool GaudiHandleArrayBase::empty ( ) const

pure virtual

Return whether the list of tools is empty.

Implemented in GaudiHandleArray< T >, GaudiHandleArray< ServiceHandle< T > >, GaudiHandleArray< ToolHandle< IMyTool > >, GaudiHandleArray< ToolHandle< IThreadInitTool > >, and GaudiHandleArray< ToolHandle< T > >.

getBaseArray() [1/2]

virtual ConstBaseHandleArray GaudiHandleArrayBase::getBaseArray ( ) const

pure virtual

Get a read-only vector of const GaudiHandleBase* pointing to the real handles.

Implemented in GaudiHandleArray.

Implemented in GaudiHandleArray< T >, GaudiHandleArray< ServiceHandle< T > >, GaudiHandleArray< ToolHandle< IMyTool > >, GaudiHandleArray< ToolHandle< IThreadInitTool > >, and GaudiHandleArray< ToolHandle< T > >.

getBaseArray() [2/2]

virtual BaseHandleArray GaudiHandleArrayBase::getBaseArray ( )

pure virtual

Get a read-write vector of GaudiHandleBase* pointing to the real handles.

Implemented in GaudiHandleArray.

Implemented in GaudiHandleArray< T >, GaudiHandleArray< ServiceHandle< T > >, GaudiHandleArray< ToolHandle< IMyTool > >, GaudiHandleArray< ToolHandle< IThreadInitTool > >, and GaudiHandleArray< ToolHandle< T > >.

getBaseInfos()

const std::vector< std::string > GaudiHandleArrayBase::getBaseInfos

(

auto(GaudiHandleBase::*

pMemFunc )() const

)

const

Helper function to get a vector of strings filled with the return value of each tool of a member function if GaudiHandleBase.

Definition at line 71 of file GaudiHandle.cpp.

                                                                                                               {
  std::vector<std::string> theList;
  for ( const auto& it : getBaseArray() ) theList.push_back( ( it->*pMemFunc )() );
  return theList;
}

names()

const std::vector< std::string > GaudiHandleArrayBase::names

(

)

const

Return a vector with "type/name" strings of all handles in the array.

Definition at line 83 of file GaudiHandle.cpp.

{ return getBaseInfos( &GaudiHandleBase::name ); }

push_back()

virtual bool GaudiHandleArrayBase::push_back ( const std::string & myHandleTypeAndName )

pure virtual

Add a handle to the array with "type/name" given in <myHandleTypeAndName>.

Return whether addition was successful or not. Must be implemented by derived class with concrete handle category.

Implemented in GaudiHandleArray< T >, GaudiHandleArray< ServiceHandle< T > >, GaudiHandleArray< ServiceHandle< T > >, GaudiHandleArray< ToolHandle< IMyTool > >, GaudiHandleArray< ToolHandle< IMyTool > >, GaudiHandleArray< ToolHandle< IThreadInitTool > >, GaudiHandleArray< ToolHandle< IThreadInitTool > >, GaudiHandleArray< ToolHandle< T > >, GaudiHandleArray< ToolHandle< T > >, ServiceHandleArray< T >, ToolHandleArray< T >, ToolHandleArray< IMyTool >, and ToolHandleArray< IThreadInitTool >.

pythonPropertyClassName()

std::string GaudiHandleArrayBase::pythonPropertyClassName ( ) const

overridevirtual

Name of the componentType with "HandleArray" appended.

Used as the python class name for the property in the genconf-generated configurables. The python class is defined in GaudiPython/python/GaudiHandles.py.

Implements GaudiHandleInfo.

Definition at line 85 of file GaudiHandle.cpp.

{ return componentType() + "HandleArray"; }

pythonRepr()

std::string GaudiHandleArrayBase::pythonRepr ( ) const

overridevirtual

Python representation of array of handles, i.e.

list of python handles. Can be used in the genconf-generated configurables. The corresponding python classes are defined in GaudiPython/GaudiHandles.py

Implements GaudiHandleInfo.

Definition at line 87 of file GaudiHandle.cpp.

                                                 {
  std::string repr    = pythonPropertyClassName() + "([";
  auto        theList = typesAndNames();
  auto        first   = theList.begin();
  auto        last    = theList.end();
  if ( first != last ) {
    repr += "'" + *first + "'";
    ++first;
  }
  for ( ; first != last; ++first ) repr += ",'" + *first + "'";
  repr += "])";
  return repr;
}

release()

virtual StatusCode GaudiHandleArrayBase::release ( )

pure virtual

Release all tools.

Implemented in GaudiHandleArray< T >, GaudiHandleArray< ServiceHandle< T > >, GaudiHandleArray< ToolHandle< IMyTool > >, GaudiHandleArray< ToolHandle< IThreadInitTool > >, and GaudiHandleArray< ToolHandle< T > >.

retrieve()

virtual StatusCode GaudiHandleArrayBase::retrieve ( )

pure virtual

Retrieve all tools.

Implemented in GaudiHandleArray< T >, GaudiHandleArray< ServiceHandle< T > >, GaudiHandleArray< ToolHandle< IMyTool > >, GaudiHandleArray< ToolHandle< IThreadInitTool > >, and GaudiHandleArray< ToolHandle< T > >.

retrieved()

virtual bool GaudiHandleArrayBase::retrieved ( ) const

pure virtual

To be able to tell if Array was ever retreived.

Implemented in GaudiHandleArray< T >, GaudiHandleArray< ServiceHandle< T > >, GaudiHandleArray< ToolHandle< IMyTool > >, GaudiHandleArray< ToolHandle< IThreadInitTool > >, and GaudiHandleArray< ToolHandle< T > >.

setTypesAndNames()

bool GaudiHandleArrayBase::setTypesAndNames

(

const std::vector< std::string > &

myTypesAndNamesList

)

Set the array of handles from list of "type/name" strings in <myTypesAndNamesList>.

Return whether set was successful or not

Definition at line 63 of file GaudiHandle.cpp.

                                                                                             {
  clear();
  for ( const auto& it : myTypesAndNamesList ) {
    if ( !push_back( it ) ) return false;
  }
  return true;
}

types()

const std::vector< std::string > GaudiHandleArrayBase::types

(

)

const

Return a vector with "type" strings of all handles in the array.

Definition at line 81 of file GaudiHandle.cpp.

{ return getBaseInfos( &GaudiHandleBase::type ); }

typesAndNames()

const std::vector< std::string > GaudiHandleArrayBase::typesAndNames

(

)

const

Return a vector with "type/name" strings of all handles in the array.

Inverse of setTypesAndNames()

Definition at line 77 of file GaudiHandle.cpp.

                                                                     {
  return getBaseInfos( &GaudiHandleBase::typeAndName );
}

---

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

• GaudiKernel/include/GaudiKernel/GaudiHandle.h
• GaudiKernel/src/Lib/GaudiHandle.cpp