DataObjectHandle< T > Class Template Reference

#include </tmp/marcocle/lhcb-release/1122/GAUDI/GAUDI_v27r0/InstallArea/x86_64-slc6-gcc49-opt/include/GaudiKernel/Algorithm.h>

Inheritance diagram for DataObjectHandle< T >:

Collaboration diagram for DataObjectHandle< T >:

Public Member Functions
	DataObjectHandle ()
	DataObjectHandle (DataObjectDescriptor &descriptor, IAlgorithm *fatherAlg)
	Initialises mother class. More...
	DataObjectHandle (DataObjectDescriptor &descriptor, IAlgTool *fatherAlg)
	Initialises mother class. More...
StatusCode	initialize ()
	Initialize. More...
StatusCode	reinitialize ()
	Reinitialize. More...
StatusCode	finalize ()
	Finalize. More...
T *	get ()
	Retrieve object from transient data store. More...
T *	getIfExists ()
	Bypass check of existence of object in transient store Only uses main location of the. More...
bool	exist ()
	Check the existence of the object in the transient store. More...
T *	getOrCreate ()
	Get object from store or create a new one if it doesn't exist. More...
void	put (T *object)
	Register object in transient store. More...
	DataObjectHandle ()
	DataObjectHandle (DataObjectDescriptor &descriptor, IAlgorithm *fatherAlg)
	Initialises mother class. More...
	DataObjectHandle (DataObjectDescriptor &descriptor, IAlgTool *fatherAlg)
	Initialises mother class. More...
StatusCode	initialize ()
	Initialize. More...
StatusCode	reinitialize ()
	Reinitialize. More...
StatusCode	finalize ()
	Finalize. More...
T *	get ()
	Retrieve object from transient data store. More...
T *	getIfExists ()
	Bypass check of existence of object in transient store Only uses main location of the. More...
bool	exist ()
	Check the existence of the object in the transient store. More...
T *	getOrCreate ()
	Get object from store or create a new one if it doesn't exist. More...
void	put (T *object)
	Register object in transient store. More...
Public Member Functions inherited from MinimalDataObjectHandle
	MinimalDataObjectHandle ()
	MinimalDataObjectHandle (DataObjectDescriptor &descriptor)
	Constructor initialises the members and registers products in SchedSvc the MinimalDataObjectHandle takes over the ownership of the descriptor. More...
virtual	~MinimalDataObjectHandle ()
bool	isOptional () const
	Check if the data object declared is optional for the algorithm. More...
void	setOptional (bool optional=true)
size_t	dataProductIndex () const
	Return the product index. More...
const std::string &	dataProductName () const
	Return the product name. More...
const std::vector< std::string > &	alternativeDataProductNames () const
StatusCode	setDataProductName (const std::string &address)
	Update address of data product if possible -> not if was written. More...
StatusCode	setAlternativeDataProductNames (const std::vector< std::string > &alternativeAddresses)
StatusCode	setDataProductNames (const std::vector< std::string > &addresses)
AccessType	accessType () const
	Access type. More...
bool	wasRead () const
	Check if operation was performed. More...
bool	wasWritten () const
	Check if operation was performed. More...
bool	isValid () const
bool	initialized () const
void	lock ()
void	unlock ()
	MinimalDataObjectHandle ()
	MinimalDataObjectHandle (DataObjectDescriptor &descriptor)
	Constructor initialises the members and registers products in SchedSvc the MinimalDataObjectHandle takes over the ownership of the descriptor. More...
virtual	~MinimalDataObjectHandle ()
bool	isOptional () const
	Check if the data object declared is optional for the algorithm. More...
void	setOptional (bool optional=true)
size_t	dataProductIndex () const
	Return the product index. More...
const std::string &	dataProductName () const
	Return the product name. More...
const std::vector< std::string > &	alternativeDataProductNames () const
StatusCode	setDataProductName (const std::string &address)
	Update address of data product if possible -> not if was written. More...
StatusCode	setAlternativeDataProductNames (const std::vector< std::string > &alternativeAddresses)
StatusCode	setDataProductNames (const std::vector< std::string > &addresses)
AccessType	accessType () const
	Access type. More...
bool	wasRead () const
	Check if operation was performed. More...
bool	wasWritten () const
	Check if operation was performed. More...
bool	isValid () const
bool	initialized () const
void	lock ()
void	unlock ()

Private Member Functions
void	setOwner (IAlgorithm *fatherAlg)
void	setOwner (IAlgTool *fatherTool)
T *	get (bool mustExist)
	Try to retrieve from the transient store. More...
	DataObjectHandle (const DataObjectHandle &)
DataObjectHandle &	operator= (const DataObjectHandle &)
void	setOwner (IAlgorithm *fatherAlg)
void	setOwner (IAlgTool *fatherTool)
T *	get (bool mustExist)
	DataObjectHandle (const DataObjectHandle &)
DataObjectHandle &	operator= (const DataObjectHandle &)

Private Attributes
SmartIF< IDataProviderSvc >	m_EDS
SmartIF< IMessageSvc >	m_MS
IAlgorithm *	m_fatherAlg
IAlgTool *	m_fatherTool
bool	m_goodType

Friends
class	Algorithm
class	AlgTool

Additional Inherited Members
Public Types inherited from MinimalDataObjectHandle
enum	AccessType {   READ, WRITE, UPDATE, READ,   WRITE, UPDATE }
	The type of the access. More...
enum	AccessType {   READ, WRITE, UPDATE, READ,   WRITE, UPDATE }
	The type of the access. More...
Protected Member Functions inherited from MinimalDataObjectHandle
void	setRead (bool wasRead=true)
void	setWritten (bool wasWritten=true)
DataObjectDescriptor *	descriptor ()
void	setRead (bool wasRead=true)
void	setWritten (bool wasWritten=true)
DataObjectDescriptor *	descriptor ()
Protected Attributes inherited from MinimalDataObjectHandle
DataObjectDescriptor *	m_descriptor

Detailed Description

template<typename T>
class DataObjectHandle< T >

Definition at line 43 of file Algorithm.h.

Constructor & Destructor Documentation

template<typename T >

DataObjectHandle< T >::DataObjectHandle

(

)

Definition at line 153 of file DataObjectHandle.h.

                                     :
  m_fatherAlg(0),
  m_fatherTool(0),
  m_goodType(false){}

template<typename T >

DataObjectHandle< T >::DataObjectHandle	(	DataObjectDescriptor &	descriptor,
		IAlgorithm *	fatherAlg
	)

Initialises mother class.

Definition at line 160 of file DataObjectHandle.h.

                                                            :
  MinimalDataObjectHandle(descriptor),
  m_fatherAlg(fatherAlg),
  m_fatherTool(0),
  m_goodType(false){}

template<typename T >

DataObjectHandle< T >::DataObjectHandle	(	DataObjectDescriptor &	descriptor,
		IAlgTool *	fatherAlg
	)

Initialises mother class.

Definition at line 169 of file DataObjectHandle.h.

                                                           :
  MinimalDataObjectHandle(descriptor),
  m_fatherAlg(0),
  m_fatherTool(fatherTool),
  m_goodType(false){}

template<typename T>

DataObjectHandle< T >::DataObjectHandle ( const DataObjectHandle< T > &  )

private

template<typename T>

DataObjectHandle< T >::DataObjectHandle

(

)

template<typename T>

DataObjectHandle< T >::DataObjectHandle	(	DataObjectDescriptor &	descriptor,
		IAlgorithm *	fatherAlg
	)

Initialises mother class.

template<typename T>

DataObjectHandle< T >::DataObjectHandle	(	DataObjectDescriptor &	descriptor,
		IAlgTool *	fatherAlg
	)

Initialises mother class.

template<typename T>

DataObjectHandle< T >::DataObjectHandle ( const DataObjectHandle< T > &  )

private

Member Function Documentation

template<typename T>

bool DataObjectHandle< T >::exist ( )

inline

Check the existence of the object in the transient store.

Definition at line 52 of file DataObjectHandle.h.

{ return get(false) != NULL; }

template<typename T>

bool DataObjectHandle< T >::exist ( )

inline

Check the existence of the object in the transient store.

Definition at line 52 of file DataObjectHandle.h.

{ return get(false) != NULL; }

template<typename T >

StatusCode DataObjectHandle< T >::finalize ( )

virtual

Finalize.

Reimplemented from MinimalDataObjectHandle.

Definition at line 146 of file DataObjectHandle.h.

                                        {
  return MinimalDataObjectHandle::finalize();
}

template<typename T>

StatusCode DataObjectHandle< T >::finalize ( )

virtual

Finalize.

Reimplemented from MinimalDataObjectHandle.

template<typename T>

T* DataObjectHandle< T >::get ( )

inline

Retrieve object from transient data store.

Definition at line 41 of file DataObjectHandle.h.

{ return get(true); }

template<typename T>

T* DataObjectHandle< T >::get ( )

inline

Retrieve object from transient data store.

Definition at line 41 of file DataObjectHandle.h.

{ return get(true); }

template<typename T >

T * DataObjectHandle< T >::get ( bool  mustExist )

private

Try to retrieve from the transient store.

If the retrieval succeded and this is the first time we retrieve, perform a dynamic cast to the desired object. Then finally set the handle as Read. If this is not the first time we cast and the cast worked, just use the static cast: we do not need the checks of the dynamic cast for every access!

Definition at line 186 of file DataObjectHandle.h.

                                          {

  //MsgStream log(m_MS,"DataObjectHandle");

  DataObject* dataObjectp = NULL;

  StatusCode sc = m_EDS->retrieveObject(dataProductName(), dataObjectp);

  //if(sc.isSuccess())
  //  log << MSG::DEBUG << "Using main location " << dataProductName() << " for " << *dataObjectp << endmsg;

  if(sc.isFailure() && ! m_descriptor->alternativeAddresses().empty()){
    for(uint i = 0; i < m_descriptor->alternativeAddresses().size() && sc.isFailure(); ++i){
      sc = m_EDS->retrieveObject(m_descriptor->alternativeAddresses()[i], dataObjectp);

      //if(sc.isSuccess())
      //  log << MSG::DEBUG << "Using alternative location " << m_descriptor->alternativeAddresses()[i] << " for " << *dataObjectp << endmsg;
    }
  }

  T* returnObject = NULL;
  if ( LIKELY( sc.isSuccess() ) ){

    if (UNLIKELY(!m_goodType)){ // Check type compatibility once

      // DP: can use a gaudi feature?
      m_goodType = (NULL != dynamic_cast<T*> (dataObjectp));
      //( typeid(tmp) == typeid(*dataObjectp) ) ;

      T tmp;

      const std::string dataType(typeid(tmp).name());

      if (!m_goodType){
        std::string errorMsg("The type provided for "+ dataProductName()
                             + " is " + dataType
                             + " and is different form the one of the object in the store.");
        //log << MSG::ERROR << errorMsg << endmsg;
        throw GaudiException (errorMsg,"Wrong DataObjectType",StatusCode::FAILURE);
      }
      else{
        //log << MSG::DEBUG <<  "The data type (" <<  dataType
        //    << ") specified for the handle of " << dataProductName()
        //    << " is the same of the object in the store. "
        //    << "From now on the result of a static_cast will be returned." << endmsg;
      }
    }

    if (LIKELY(m_goodType)) { // From the second read on, this is safe
      returnObject = static_cast<T*> (dataObjectp);
    }

  }
  else if(mustExist){ // Problems in getting from the store
    throw GaudiException("Cannot retrieve " + dataProductName() + " from transient store.",
                         m_fatherAlg != 0 ? m_fatherAlg->name() : m_fatherTool->name(), StatusCode::FAILURE);
  }

  setRead();
  return returnObject;
}

template<typename T>

T* DataObjectHandle< T >::get ( bool  mustExist )

private

template<typename T>

T* DataObjectHandle< T >::getIfExists ( )

inline

Bypass check of existence of object in transient store Only uses main location of the.

Definition at line 47 of file DataObjectHandle.h.

{ return get(false); }

template<typename T>

T* DataObjectHandle< T >::getIfExists ( )

inline

Bypass check of existence of object in transient store Only uses main location of the.

Definition at line 47 of file DataObjectHandle.h.

{ return get(false); }

template<typename T>

T* DataObjectHandle< T >::getOrCreate

(

)

Get object from store or create a new one if it doesn't exist.

template<typename T >

T * DataObjectHandle< T >::getOrCreate

(

)

Get object from store or create a new one if it doesn't exist.

Definition at line 259 of file DataObjectHandle.h.

                                    {

    //this process needs to be locking for multi-threaded applications
    //lock(); --> done in caller

    T* obj = get(false);

    //object exists, we are done
    if(obj != NULL){

        //unlock();
        return obj;
    }

    //MsgStream log(m_MS,"DataObjectHandle");
    //log << MSG::DEBUG << "Object " << dataProductName() << " does not exist, creating it" << endmsg;

    //create it
    obj = new T();
    put(obj);

    //unlock();
    return obj;
}

template<typename T >

StatusCode DataObjectHandle< T >::initialize ( )

virtual

Initialize.

Reimplemented from MinimalDataObjectHandle.

Definition at line 91 of file DataObjectHandle.h.

                                          {

  // GCCXML cannot understand c++11 yet, NULL used.

  MinimalDataObjectHandle::initialize().ignore();

  if(m_fatherAlg == 0 && m_fatherTool == 0){
    return StatusCode::FAILURE;
  }

  if (m_fatherAlg != 0) {
    // Fetch the event Data Service from the algorithm
    Algorithm* algorithm = dynamic_cast<Algorithm*>(m_fatherAlg);
    if (LIKELY(algorithm != NULL)) {
      m_EDS = algorithm->evtSvc();
      m_MS = algorithm->msgSvc();
    } else
      throw GaudiException(
          "Cannot cast " + m_fatherAlg->name() + " to Algorithm.",
          "Invalid Cast", StatusCode::FAILURE);
  }

  if (m_fatherTool != 0) {
    // Fetch the event Data Service from the algorithm
    AlgTool* tool = dynamic_cast<AlgTool*>(m_fatherTool);
    if (LIKELY(tool != NULL)) {
      m_EDS = tool->evtSvc();
      m_MS = tool->msgSvc();
    } else
      throw GaudiException(
          "Cannot cast " + m_fatherTool->name() + " to AlgTool.",
          "Invalid Cast", StatusCode::FAILURE);
  }

   m_goodType = false;

   return StatusCode::SUCCESS;
}

template<typename T>

StatusCode DataObjectHandle< T >::initialize ( )

virtual

Initialize.

Reimplemented from MinimalDataObjectHandle.

template<typename T>

DataObjectHandle& DataObjectHandle< T >::operator= ( const DataObjectHandle< T > &  )

private

template<typename T>

DataObjectHandle& DataObjectHandle< T >::operator= ( const DataObjectHandle< T > &  )

private

template<typename T>

void DataObjectHandle< T >::put

(

T *

object

)

Register object in transient store.

Definition at line 250 of file DataObjectHandle.h.

                                        {

    StatusCode sc = m_EDS->registerObject(dataProductName(), objectp);
    if ( LIKELY( sc.isSuccess() ) )
    setWritten();
}

template<typename T>

void DataObjectHandle< T >::put

(

T *

object

)

Register object in transient store.

template<typename T >

StatusCode DataObjectHandle< T >::reinitialize ( )

virtual

Reinitialize.

Reimplemented from MinimalDataObjectHandle.

Definition at line 132 of file DataObjectHandle.h.

                                            {

  StatusCode sc = MinimalDataObjectHandle::reinitialize();

  if(sc.isFailure())
    return sc;

  m_goodType = false;

  return StatusCode::SUCCESS;
}

template<typename T>

StatusCode DataObjectHandle< T >::reinitialize ( )

virtual

Reinitialize.

Reimplemented from MinimalDataObjectHandle.

template<typename T>

void DataObjectHandle< T >::setOwner ( IAlgorithm *  fatherAlg )

inlineprivate

Definition at line 65 of file DataObjectHandle.h.

                                       {
    m_fatherAlg = fatherAlg;
    m_fatherTool = 0;
  }

template<typename T>

void DataObjectHandle< T >::setOwner ( IAlgorithm *  fatherAlg )

inlineprivate

Definition at line 65 of file DataObjectHandle.h.

                                       {
    m_fatherAlg = fatherAlg;
    m_fatherTool = 0;
  }

template<typename T>

void DataObjectHandle< T >::setOwner ( IAlgTool *  fatherTool )

inlineprivate

Definition at line 70 of file DataObjectHandle.h.

                                      {
    m_fatherAlg = 0;
    m_fatherTool = fatherTool;
  }

template<typename T>

void DataObjectHandle< T >::setOwner ( IAlgTool *  fatherTool )

inlineprivate

Definition at line 70 of file DataObjectHandle.h.

                                      {
    m_fatherAlg = 0;
    m_fatherTool = fatherTool;
  }

Friends And Related Function Documentation

template<typename T>

Algorithm

friend

Definition at line 15 of file DataObjectHandle.h.

template<typename T>

AlgTool

friend

Definition at line 16 of file DataObjectHandle.h.

Member Data Documentation

template<typename T>

SmartIF< IDataProviderSvc > DataObjectHandle< T >::m_EDS

private

Definition at line 79 of file DataObjectHandle.h.

template<typename T>

IAlgorithm * DataObjectHandle< T >::m_fatherAlg

private

Definition at line 81 of file DataObjectHandle.h.

template<typename T>

IAlgTool * DataObjectHandle< T >::m_fatherTool

private

Definition at line 82 of file DataObjectHandle.h.

template<typename T>

bool DataObjectHandle< T >::m_goodType

private

Definition at line 83 of file DataObjectHandle.h.

template<typename T>

SmartIF< IMessageSvc > DataObjectHandle< T >::m_MS

private

Definition at line 80 of file DataObjectHandle.h.

---

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

• InstallArea/x86_64-slc6-gcc49-opt/include/GaudiKernel/Algorithm.h
• InstallArea/x86_64-slc6-gcc49-opt/include/GaudiKernel/DataObjectHandle.h