DataObjectHandle< T > Class Template Reference

DataObjectHandle.h GaudiKernel/DataObjectHandle.h. More...

#include <GaudiKernel/AlgTool.h>

Inheritance diagram for DataObjectHandle< T >:

Collaboration diagram for DataObjectHandle< T >:

Public Member Functions
	DataObjectHandle ()
	DataObjectHandle (const DataObjID &k, Gaudi::DataHandle::Mode a, IDataHandleHolder *o)
	DataObjectHandle (const std::string &k, Gaudi::DataHandle::Mode a, IDataHandleHolder *o)
virtual	~DataObjectHandle ()
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 DataObjectHandleBase
	DataObjectHandleBase ()
	DataObjectHandleBase (const DataObjID &k, Gaudi::DataHandle::Mode a, IDataHandleHolder *o)
	DataObjectHandleBase (const std::string &k, Gaudi::DataHandle::Mode a, IDataHandleHolder *o)
virtual	~DataObjectHandleBase ()
const std::string	toString () const
const std::string	pythonRepr () const override
void	fromString (const std::string &s)
bool	isOptional () const
	Check if the data object declared is optional for the algorithm. More...
void	setOptional (bool optional=true)
const std::vector< std::string > &	alternativeDataProductNames () const
void	setAlternativeDataProductNames (const std::vector< std::string > &alternativeAddresses)
bool	initialized () const
bool	wasRead () const
bool	wasWritten () const
bool	isValid () const
Public Member Functions inherited from Gaudi::DataHandle
	DataHandle ()
	DataHandle (const DataObjID &k, Mode a=Reader, IDataHandleHolder *owner=0)
virtual	~DataHandle ()
virtual void	setOwner (IDataHandleHolder *o)
virtual IDataHandleHolder *	owner () const
virtual Mode	mode () const
virtual void	setKey (const DataObjID &key)
virtual void	updateKey (const std::string &key)
virtual const std::string &	objKey () const
virtual const DataObjID &	fullKey () const
virtual void	reset (bool)
virtual StatusCode	commit ()

Private Member Functions
T *	get (bool mustExist)
	Try to retrieve from the transient store. More...

Additional Inherited Members
Public Types inherited from Gaudi::DataHandle
enum	Mode { Reader = 1<<2, Writer = 1<<4, Updater = Reader | Writer }
Protected Member Functions inherited from DataObjectHandleBase
void	setRead (bool wasRead=true)
void	setWritten (bool wasWritten=true)
void	init ()
Protected Member Functions inherited from Gaudi::DataHandle
virtual void	setMode (const Mode &mode)
Protected Attributes inherited from DataObjectHandleBase
SmartIF< IDataProviderSvc >	m_EDS
SmartIF< IMessageSvc >	m_MS
bool	m_init
bool	m_goodType
bool	m_optional
bool	m_wasRead
bool	m_wasWritten
std::vector< std::string >	m_altNames
Protected Attributes inherited from Gaudi::DataHandle
DataObjID	m_key
IDataHandleHolder *	m_owner

Detailed Description

template<typename T>
class DataObjectHandle< T >

DataObjectHandle.h GaudiKernel/DataObjectHandle.h.

Templated Handle class for objects in the event store

Inheritance: DataHandle->DataObjectHandleBase->DataObjectHandle<T>

Author

Charles Leggett

Date

2015-09-01

Definition at line 25 of file AlgTool.h.

Constructor & Destructor Documentation

template<typename T >

DataObjectHandle< T >::DataObjectHandle

(

)

Definition at line 75 of file DataObjectHandle.h.

                                     :
  DataObjectHandleBase() {}

template<typename T >

DataObjectHandle< T >::DataObjectHandle	(	const DataObjID &	k,
		Gaudi::DataHandle::Mode	a,
		IDataHandleHolder *	o
	)

Definition at line 80 of file DataObjectHandle.h.

                                               :
  DataObjectHandleBase(k,a,owner) {}

template<typename T >

DataObjectHandle< T >::DataObjectHandle	(	const std::string &	k,
		Gaudi::DataHandle::Mode	a,
		IDataHandleHolder *	o
	)

Definition at line 86 of file DataObjectHandle.h.

                                               :
  DataObjectHandleBase(k,a,owner) {} 

template<typename T>

virtual DataObjectHandle< T >::~DataObjectHandle ( )

inlinevirtual

Definition at line 38 of file DataObjectHandle.h.

{}

Member Function Documentation

template<typename T>

bool DataObjectHandle< T >::exist ( )

inline

Check the existence of the object in the transient store.

Definition at line 54 of file DataObjectHandle.h.

{ return get(false) != NULL; }

template<typename T>

T* DataObjectHandle< T >::get ( )

inline

Retrieve object from transient data store.

Definition at line 43 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 101 of file DataObjectHandle.h.

                                          {

  if (!m_init) {
    init();
  }

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

  DataObject* dataObjectp = NULL;

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

  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 "+ objKey()
                             + " 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 " + objKey() + 
             " from transient store.",
             m_owner != 0 ? owner()->name() : "no owner",
             StatusCode::FAILURE);
  }

  //  setRead();
  return returnObject;
}

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

Definition at line 173 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 " << objKey() << " does not exist, creating it" << endmsg;

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

    //unlock();
    return obj;
}

template<typename T>

void DataObjectHandle< T >::put

(

T *

object

)

Register object in transient store.

Definition at line 159 of file DataObjectHandle.h.

                                        {

  if (!m_init) {
    init();
  }

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

---

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

• GaudiKernel/GaudiKernel/AlgTool.h
• GaudiKernel/GaudiKernel/DataObjectHandle.h