In This Package:

GaudiHandle< T > Class Template Reference

Handle to be used in lieu of naked pointers to gaudis. More...

#include <GaudiKernel/GaudiHandle.h>

Inheritance diagram for GaudiHandle< T >:

[legend]Collaboration diagram for GaudiHandle< T >:[legend]List of all members.

Public Member Functions
	GaudiHandle (const GaudiHandle &other)
	Copy constructor needed for correct ref-counting.
GaudiHandle &	operator= (const GaudiHandle &other)
	Assignment operator for correct ref-counting.
StatusCode	retrieve () const
	Retrieve the component.
StatusCode	release () const
	Release the component.
	operator bool () const
	For testing if handle has component.
T &	operator * ()
T *	operator-> ()
T &	operator * () const
T *	operator-> () const
std::string	getDefaultType ()
	Helper function to get default type string from the class type.
std::string	getDefaultName ()
std::string	typeAndName () const
	The full type and name: "type/name".
std::string	type () const
	The concrete component class name: the part before the '/'.
std::string	name () const
	The instance name: the part after the '/'.
bool	empty () const
	Check if the handle has been set to empty string (i.e.
void	setTypeAndName (const std::string &myTypeAndName)
	The component "type/name" string.
void	setName (const std::string &myName)
	Set the instance name (part after the '/') without changing the class type.
const std::string	pythonPropertyClassName () const
	Name of the componentType with "Handle" appended.
const std::string	messageName () const
	name used for printing messages
virtual const std::string	pythonRepr () const
	Python representation of handle, i.e.
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.
Protected Member Functions
	GaudiHandle (const std::string &myTypeAndName, const std::string &myComponentType, const std::string &myParentName)
virtual StatusCode	retrieve (T *&) const =0
	Retrieve the component.
virtual StatusCode	release (T *comp) const
	Release the component.
Private Member Functions
void	setDefaultTypeAndName ()
	Helper function to set default name and type.
void	setDefaultType ()
	Helper function to set default type from the class type T.
bool	getObject () const
	Load the pointer to the component.
void	assertObject () const
	Load the pointer to the component.
Private Attributes
T *	m_pObject

---

Detailed Description

template<class T>
class GaudiHandle< T >

Handle to be used in lieu of naked pointers to gaudis.

This allows better control through the framework of gaudi loading and usage. T is the type of the component interface (or concrete class).

Author:

Martin.Woudstra@cern.ch

Definition at line 158 of file GaudiHandle.h.

---

Constructor & Destructor Documentation

template<class T>

GaudiHandle< T >::GaudiHandle	(	const std::string &	myTypeAndName,
		const std::string &	myComponentType,
		const std::string &	myParentName
	)			[inline, protected]

Definition at line 163 of file GaudiHandle.h.

    : GaudiHandleBase(myTypeAndName, myComponentType, myParentName), m_pObject(0) 
  {}

template<class T>

GaudiHandle< T >::GaudiHandle

(

const GaudiHandle< T > &

other

)

[inline]

Copy constructor needed for correct ref-counting.

Definition at line 170 of file GaudiHandle.h.

    : GaudiHandleBase( other ) {
    m_pObject = other.m_pObject;
    if ( m_pObject ) m_pObject->addRef();
  }

---

Member Function Documentation

template<class T>

GaudiHandle& GaudiHandle< T >::operator=

(

const GaudiHandle< T > &

other

)

[inline]

Assignment operator for correct ref-counting.

Definition at line 177 of file GaudiHandle.h.

                                                     {
    GaudiHandleBase::operator=( other );
    // release any current tool
    release().ignore();
    m_pObject = other.m_pObject;
    // update ref-counting
    if ( m_pObject ) m_pObject->addRef();
    return *this;
  }

template<class T>

StatusCode GaudiHandle< T >::retrieve

(

)

const [inline]

Retrieve the component.

Release existing component if needed.

Reimplemented in ServiceHandle< T >, ToolHandle< T >, and ServiceHandle< IToolSvc >.

Definition at line 188 of file GaudiHandle.h.

                              { // not really const, because it updates m_pObject
    if ( m_pObject && release().isFailure() ) return StatusCode::FAILURE;
    if ( retrieve( m_pObject ).isFailure() ) {
      m_pObject = 0;
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  }

template<class T>

StatusCode GaudiHandle< T >::release

(

)

const [inline]

Release the component.

Reimplemented in ToolHandle< T >.

Definition at line 198 of file GaudiHandle.h.

                             { // not really const, because it updates m_pObject
    if ( m_pObject ) {
      StatusCode sc = release( m_pObject );
      m_pObject = 0;
      return sc;
    }
    return StatusCode::SUCCESS;
  }

template<class T>

GaudiHandle< T >::operator bool

(

)

const [inline]

For testing if handle has component.

Does retrieve() if needed. If this returns false, the component could not be retrieved.

Definition at line 209 of file GaudiHandle.h.

                        { // not really const, because it may update m_pObject 
    return getObject();
  }

template<class T>

T& GaudiHandle< T >::operator *

(

)

[inline]

Definition at line 213 of file GaudiHandle.h.

                 { 
    assertObject();
    return *m_pObject;
  }

template<class T>

T* GaudiHandle< T >::operator->

(

)

[inline]

Definition at line 218 of file GaudiHandle.h.

                  { 
    assertObject();
    return m_pObject; 
  }

template<class T>

T& GaudiHandle< T >::operator *

(

)

const [inline]

Definition at line 223 of file GaudiHandle.h.

                       { // not really const, because it may update m_pObject 
    assertObject();
    return *m_pObject; 
  }

template<class T>

T* GaudiHandle< T >::operator->

(

)

const [inline]

Definition at line 228 of file GaudiHandle.h.

                        { // not really const, because it may update m_pObject 
    assertObject();
    return m_pObject;
  }

template<class T>

std::string GaudiHandle< T >::getDefaultType

(

)

[inline]

Helper function to get default type string from the class type.

Definition at line 234 of file GaudiHandle.h.

                             {  
    return System::typeinfoName( typeid(T) );
  }

template<class T>

std::string GaudiHandle< T >::getDefaultName

(

)

[inline]

Definition at line 238 of file GaudiHandle.h.

                             {
    std::string defName = GaudiHandleBase::type();
    if ( defName.empty() ) defName = getDefaultType();
    return defName;
  }

template<class T>

virtual StatusCode GaudiHandle< T >::retrieve

(

T *&

)

const [protected, pure virtual]

Retrieve the component.

To be implemented by the derived class. It will pass the pointer

Implemented in ServiceHandle< T >, ToolHandle< T >, and ServiceHandle< IToolSvc >.

template<class T>

virtual StatusCode GaudiHandle< T >::release

(

T *

comp

)

const [inline, protected, virtual]

Release the component.

Default implementation calls release() on the component. Can be overridden by the derived class if something else if needed.

Reimplemented in ToolHandle< T >.

Definition at line 250 of file GaudiHandle.h.

                                              { // not really const, because it updates m_pObject
    comp->release();
    return StatusCode::SUCCESS;
  }

template<class T>

void GaudiHandle< T >::setDefaultTypeAndName

(

)

[inline, private]

Helper function to set default name and type.

Definition at line 257 of file GaudiHandle.h.

                               {
    const std::string& myType = getDefaultType();
    GaudiHandleBase::setTypeAndName(myType+'/'+myType);
  }

template<class T>

void GaudiHandle< T >::setDefaultType

(

)

[inline, private]

Helper function to set default type from the class type T.

Definition at line 263 of file GaudiHandle.h.

                        {  
    GaudiHandleBase::setTypeAndName( getDefaultType() ); 
  }

template<class T>

bool GaudiHandle< T >::getObject

(

)

const [inline, private]

Load the pointer to the component.

Do a retrieve if needed

Definition at line 268 of file GaudiHandle.h.

                         { // not really const, because it may update m_pObject 
    return m_pObject || retrieve().isSuccess();
  }

template<class T>

void GaudiHandle< T >::assertObject

(

)

const [inline, private]

Load the pointer to the component.

Do a retrieve if needed. Throw an exception if retrieval fails.

Definition at line 274 of file GaudiHandle.h.

                            { // not really const, because it may update m_pObject 
    if ( !getObject() ) {
      throw GaudiException("Failed to retrieve " + componentType() + ": " + typeAndName(),
                           componentType() + " retrieve", StatusCode::FAILURE);
    }
  }

std::string GaudiHandleBase::typeAndName

(

)

const [inline, inherited]

The full type and name: "type/name".

Definition at line 107 of file GaudiHandle.h.

                                { 
     return m_typeAndName;
  }

std::string GaudiHandleBase::type

(

)

const [inherited]

The concrete component class name: the part before the '/'.

std::string GaudiHandleBase::name

(

)

const [inherited]

The instance name: the part after the '/'.

bool GaudiHandleBase::empty

(

)

const [inline, inherited]

Check if the handle has been set to empty string (i.e.

typeAndName string is empty).

Definition at line 118 of file GaudiHandle.h.

                     {
    return m_typeAndName.empty();
  }

void GaudiHandleBase::setTypeAndName

(

const std::string &

myTypeAndName

)

[inherited]

The component "type/name" string.

void GaudiHandleBase::setName

(

const std::string &

myName

)

[inherited]

Set the instance name (part after the '/') without changing the class type.

const std::string GaudiHandleBase::pythonPropertyClassName

(

)

const [virtual, inherited]

Name of the componentType with "Handle" 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.

const std::string GaudiHandleBase::messageName

(

)

const [inherited]

name used for printing messages

virtual const std::string GaudiHandleBase::pythonRepr

(

)

const [virtual, inherited]

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

Implements GaudiHandleInfo.

const std::string& GaudiHandleInfo::componentType

(

)

const [inline, inherited]

Definition at line 33 of file GaudiHandle.h.

                                         {
     return m_componentType;
  }

const std::string& GaudiHandleInfo::propertyName

(

)

const [inline, inherited]

name as used in declareProperty(name,gaudiHandle)

Definition at line 38 of file GaudiHandle.h.

                                        {
     return m_propertyName;
  }

void GaudiHandleInfo::setPropertyName

(

const std::string &

propName

)

[inline, inherited]

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

Used in printout.

Definition at line 43 of file GaudiHandle.h.

                                                    {
    m_propertyName = propName;
  }

const std::string& GaudiHandleInfo::parentName

(

)

const [inline, inherited]

The name of the parent.

Definition at line 48 of file GaudiHandle.h.

                                      {
    return m_parentName;
  }

---

Member Data Documentation

template<class T>

T* GaudiHandle< T >::m_pObject [mutable, private]

Definition at line 283 of file GaudiHandle.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiKernel/GaudiKernel/GaudiHandle.h

---