DataObjectHandle< AnyDataWithViewWrapper< View, Owned > > Class Template Reference

specialization for AnyDataWithViewWrapper More...

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

Inheritance diagram for DataObjectHandle< AnyDataWithViewWrapper< View, Owned > >:

Collaboration diagram for DataObjectHandle< AnyDataWithViewWrapper< View, Owned > >:

Public Member Functions
View *	get () const
	Retrieve object from transient data store. More...
View *	getIfExists () const
const View *	put (std::unique_ptr< AnyDataWithViewWrapper< View, Owned >> objectp) const
	Register object in transient store. More...
const View *	put (Owned &&obj) const
std::optional< std::size_t >	size () const
	Size of boxed item, if boxed item has a 'size' method. More...
std::string	pythonRepr () const override
	DataObjectHandleBase (DataObjID k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	DataObjectHandleBase (std::string k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	DataObjectHandleBase (const DataObjectHandleBase &)=delete
	DataObjectHandleBase (DataObjectHandleBase &&)
template<class OWNER , class K , typename = std::enable_if_t<std::is_base_of_v<IProperty, OWNER>>>
	DataObjectHandleBase (OWNER *owner, Gaudi::DataHandle::Mode m, std::string name, K key={}, std::string doc="")
	Autodeclaring constructor with property name, mode, key and documentation. More...
Public Member Functions inherited from DataObjectHandleBase
	DataObjectHandleBase (DataObjID k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	DataObjectHandleBase (std::string k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	~DataObjectHandleBase () override
	DataObjectHandleBase (const DataObjectHandleBase &)=delete
	DataObjectHandleBase (DataObjectHandleBase &&)
DataObjectHandleBase &	operator= (const DataObjectHandleBase &)
template<class OWNER , class K , typename = std::enable_if_t<std::is_base_of_v<IProperty, OWNER>>>
	DataObjectHandleBase (OWNER *owner, Gaudi::DataHandle::Mode m, std::string name, K key={}, std::string doc="")
	Autodeclaring constructor with property name, mode, key and documentation. More...
bool	isOptional () const
	Check if the data object declared is optional for the algorithm. More...
void	setOptional (bool optional=true)
bool	isValid () const
Public Member Functions inherited from Gaudi::DataHandle
	DataHandle (DataObjID k, Mode a=Reader, IDataHandleHolder *owner=nullptr)
	DataHandle (DataObjID k, bool isCond, Mode a=Reader, IDataHandleHolder *owner=nullptr)
virtual	~DataHandle ()=default
virtual void	setOwner (IDataHandleHolder *o)
virtual IDataHandleHolder *	owner () const
virtual Mode	mode () const
virtual void	setKey (DataObjID key) const
virtual void	updateKey (std::string key) const
virtual const std::string &	objKey () const
virtual const DataObjID &	fullKey () const
virtual void	reset (bool)
virtual bool	isCondition () const

Private Member Functions
AnyDataWithViewWrapper< View, Owned > *	_get (bool mustExist) const

Private Attributes
bool	m_goodType = false

Additional Inherited Members
Public Types inherited from Gaudi::DataHandle
enum	Mode { Reader = 1 << 2, Writer = 1 << 4 }
using	PropertyType = DataHandleProperty
Protected Member Functions inherited from DataObjectHandleBase
bool	init () override
DataObject *	fetch () const
Protected Attributes inherited from DataObjectHandleBase
SmartIF< IDataProviderSvc >	m_EDS
SmartIF< IMessageSvc >	m_MS
bool	m_init = false
bool	m_optional = false
std::atomic< bool >	m_searchDone = false
	Whether the search part of the fetch method (so dealing with alt names was already executed or not. More...
std::mutex	m_searchMutex
	A Mutex protecting the calls to the search part of the fetch method, so that we are sure that we only call it once. More...
Protected Attributes inherited from Gaudi::DataHandle
DataObjID	m_key = { "NONE" }
	The key of the object behind this DataHandle Although it may look strange to have it mutable, this can actually change in case the object had alternative names, and it should not be visible to the end user, for which the Handle is still the same. More...
IDataHandleHolder *	m_owner = nullptr
Static Protected Attributes inherited from Gaudi::DataHandle
static const std::string	default_type = "unknown_t"

Detailed Description

template<typename View, typename Owned>
class DataObjectHandle< AnyDataWithViewWrapper< View, Owned > >

specialization for AnyDataWithViewWrapper

Definition at line 340 of file DataObjectHandle.h.

Member Function Documentation

_get()

template<typename View , typename Owned >

AnyDataWithViewWrapper<View, Owned>* DataObjectHandle< AnyDataWithViewWrapper< View, Owned > >::_get ( bool  mustExist ) const

inlineprivate

Definition at line 379 of file DataObjectHandle.h.

                                                                    {
    auto obj = fetch();
    if ( !obj ) {
      if ( mustExist ) {
        throw GaudiException( "Cannot retrieve " + objKey() + " from transient store.",
                              m_owner ? owner()->name() : "no owner", StatusCode::FAILURE );
 
      } else {
        return nullptr;
      }
    }
    if ( !m_goodType ) m_goodType = ::details::verifyType<AnyDataWithViewWrapper<View, Owned>>( obj );
    return static_cast<AnyDataWithViewWrapper<View, Owned>*>( obj );
  }

DataObjectHandleBase() [1/5]

template<typename View , typename Owned >

DataObjectHandleBase::DataObjectHandleBase

delete

DataObjectHandleBase() [2/5]

template<typename View , typename Owned >

DataObjectHandleBase::DataObjectHandleBase

Definition at line 43 of file DataObjectHandleBase.cpp.

    : Gaudi::DataHandle( other )
    , m_EDS( std::move( other.m_EDS ) )
    , m_MS( std::move( other.m_MS ) )
    , m_init( other.m_init )
    , m_optional( other.m_optional )
    , m_searchDone( other.m_searchDone.load() ) {
  m_owner->declare( *this );
}

DataObjectHandleBase() [3/5]

template<typename View , typename Owned >

DataObjectHandleBase::DataObjectHandleBase

Definition at line 38 of file DataObjectHandleBase.cpp.

    : Gaudi::DataHandle( std::move( k ), a, owner ) {
  m_owner->declare( *this );
}

DataObjectHandleBase() [4/5]

template<typename View , typename Owned >

template<class OWNER , class K , typename = std::enable_if_t<std::is_base_of_v<IProperty, OWNER>>>

DataObjectHandleBase::DataObjectHandleBase ( class OWNER  , class K  , typename  = std::enable_if_t<std::is_base_of_v<IProperty, OWNER>>  )

inline

Autodeclaring constructor with property name, mode, key and documentation.

Note

the use std::enable_if is required to avoid ambiguities

Definition at line 49 of file DataObjectHandleBase.h.

                                                                                            {},
                               std::string doc = "" )
      : DataObjectHandleBase( std::move( key ), m, owner ) {
    auto p = owner->declareProperty( std::move( name ), *this, std::move( doc ) );
    p->template setOwnerType<OWNER>();
  }

DataObjectHandleBase() [5/5]

template<typename View , typename Owned >

DataObjectHandleBase::DataObjectHandleBase

Definition at line 39 of file DataObjectHandleBase.cpp.

    : DataObjectHandleBase( DataObjID{ std::move( k ) }, a, owner ) {}

get()

template<typename View , typename Owned >

View* DataObjectHandle< AnyDataWithViewWrapper< View, Owned > >::get ( ) const

inline

Retrieve object from transient data store.

Definition at line 347 of file DataObjectHandle.h.

{ return &_get( true )->getData(); }

getIfExists()

template<typename View , typename Owned >

View* DataObjectHandle< AnyDataWithViewWrapper< View, Owned > >::getIfExists ( ) const

inline

Definition at line 348 of file DataObjectHandle.h.

                            {
    auto data = _get( false );
    return data ? &data->getData() : nullptr;
  }

put() [1/2]

template<typename View , typename Owned >

const View* DataObjectHandle< AnyDataWithViewWrapper< View, Owned > >::put ( Owned &&  obj ) const

inline

Definition at line 363 of file DataObjectHandle.h.

                                       {
    return put( std::make_unique<AnyDataWithViewWrapper<View, Owned>>( std::move( obj ) ) );
  }

put() [2/2]

template<typename View , typename Owned >

const View* DataObjectHandle< AnyDataWithViewWrapper< View, Owned > >::put ( std::unique_ptr< AnyDataWithViewWrapper< View, Owned >>  objectp ) const

inline

Register object in transient store.

Definition at line 356 of file DataObjectHandle.h.

                                                                                      {
    assert( m_init );
    if ( auto sc = m_EDS->registerObject( objKey(), objectp.get() ); sc.isFailure() ) {
      throw GaudiException( "Error in put of " + objKey(), "DataObjectHandle<AnyDataWithViewWrapper<T>::put", sc );
    }
    return &objectp.release()->getData();
  }

pythonRepr()

template<typename View , typename Owned >

std::string DataObjectHandle< AnyDataWithViewWrapper< View, Owned > >::pythonRepr ( ) const

inlineoverridevirtual

Reimplemented from Gaudi::DataHandle.

Definition at line 372 of file DataObjectHandle.h.

                                        {
    auto repr = DataObjectHandleBase::pythonRepr();
    boost::replace_all( repr, default_type, System::typeinfoName( typeid( View ) ) );
    return repr;
  }

size()

template<typename View , typename Owned >

std::optional<std::size_t> DataObjectHandle< AnyDataWithViewWrapper< View, Owned > >::size ( ) const

inline

Size of boxed item, if boxed item has a 'size' method.

Definition at line 370 of file DataObjectHandle.h.

{ return _get()->size(); }

Member Data Documentation

m_goodType

template<typename View , typename Owned >

bool DataObjectHandle< AnyDataWithViewWrapper< View, Owned > >::m_goodType = false

mutableprivate

Definition at line 393 of file DataObjectHandle.h.

---

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

• GaudiKernel/include/GaudiKernel/DataObjectHandle.h