DataObjectHandle< Gaudi::NamedRange_< T > > Class Template Reference

specialization for NamedRange_ More...

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

Inheritance diagram for DataObjectHandle< Gaudi::NamedRange_< T > >:

Collaboration diagram for DataObjectHandle< Gaudi::NamedRange_< T > >:

Public Types
using	ValueType = std::remove_cv_t< std::remove_pointer_t< typename T::value_type > >
using	Range = Gaudi::NamedRange_< typename ValueType::ConstVector >
Public Types inherited from Gaudi::DataHandle
enum	Mode { Reader = 1 << 2, Writer = 1 << 4 }
using	PropertyType = DataHandleProperty

Public Member Functions
Range	get () const
	Retrieve object from transient data store. 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 Attributes
mutable ::details::Converter_t< Range >	m_converter = nullptr

Additional Inherited Members
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 T>
class DataObjectHandle< Gaudi::NamedRange_< T > >

specialization for NamedRange_

Definition at line 239 of file DataObjectHandle.h.

Member Typedef Documentation

Range

template<typename T >

using DataObjectHandle< Gaudi::NamedRange_< T > >::Range = Gaudi::NamedRange_<typename ValueType::ConstVector>

Definition at line 242 of file DataObjectHandle.h.

ValueType

template<typename T >

using DataObjectHandle< Gaudi::NamedRange_< T > >::ValueType = std::remove_cv_t<std::remove_pointer_t<typename T::value_type> >

Definition at line 241 of file DataObjectHandle.h.

Member Function Documentation

DataObjectHandleBase() [1/5]

template<typename T >

DataObjectHandleBase::DataObjectHandleBase

delete

DataObjectHandleBase() [2/5]

template<typename T >

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 T >

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 T >

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 T >

DataObjectHandleBase::DataObjectHandleBase

Definition at line 39 of file DataObjectHandleBase.cpp.

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

get()

template<typename T >

Range DataObjectHandle< Gaudi::NamedRange_< T > >::get

(

)

const

Retrieve object from transient data store.

pythonRepr()

template<typename T >

std::string DataObjectHandle< Gaudi::NamedRange_< T > >::pythonRepr ( ) const

inlineoverridevirtual

Reimplemented from Gaudi::DataHandle.

Definition at line 251 of file DataObjectHandle.h.

                                        {
    auto repr = DataObjectHandleBase::pythonRepr();
    boost::replace_all( repr, default_type, System::typeinfoName( typeid( Gaudi::NamedRange_<T> ) ) );
    return repr;
  }

Member Data Documentation

m_converter

template<typename T >

mutable ::details::Converter_t<Range> DataObjectHandle< Gaudi::NamedRange_< T > >::m_converter = nullptr

private

Definition at line 258 of file DataObjectHandle.h.

---

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

• GaudiKernel/include/GaudiKernel/DataObjectHandle.h