DataHandleHolderBase< BASE > Class Template Reference

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

Inheritance diagram for DataHandleHolderBase< BASE >:

Collaboration diagram for DataHandleHolderBase< BASE >:

Public Member Functions
std::vector< Gaudi::DataHandle * >	inputHandles () const override
std::vector< Gaudi::DataHandle * >	outputHandles () const override
virtual const DataObjIDColl &	extraInputDeps () const override
virtual const DataObjIDColl &	extraOutputDeps () const override
void	declare (Gaudi::DataHandle &handle) override
void	renounce (Gaudi::DataHandle &handle) override
bool	renounceInput (const DataObjID &id) override
const DataObjIDColl &	inputDataObjs () const override
const DataObjIDColl &	outputDataObjs () const override
void	addDependency (const DataObjID &id, const Gaudi::DataHandle::Mode &mode) override
Public Member Functions inherited from extends< BASE, IDataHandleHolder >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

Protected Member Functions
void	initDataHandleHolder ()
	initializes all handles - called by the sysInitialize method of any descendant of this More...

Protected Attributes
DataObjIDColl	m_inputDataObjs
DataObjIDColl	m_outputDataObjs

Private Attributes
std::unordered_set< Gaudi::DataHandle * >	m_handles
Gaudi::Property< DataObjIDColl >	m_extInputDataObjs { this, "ExtraInputs", DataObjIDColl{} }
Gaudi::Property< DataObjIDColl >	m_extOutputDataObjs { this, "ExtraOutputs", DataObjIDColl{} }

Additional Inherited Members
Public Types inherited from extends< BASE, IDataHandleHolder >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...
Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...

Detailed Description

template<class BASE>
class DataHandleHolderBase< BASE >

Definition at line 33 of file DataHandleHolderBase.h.

Member Function Documentation

addDependency()

template<class BASE >

void DataHandleHolderBase< BASE >::addDependency ( const DataObjID &  id, const Gaudi::DataHandle::Mode &  mode  )

inlineoverride

Definition at line 85 of file DataHandleHolderBase.h.

                                                                                      {
    if ( mode & Gaudi::DataHandle::Reader ) m_inputDataObjs.emplace( id );
    if ( mode & Gaudi::DataHandle::Writer ) m_outputDataObjs.emplace( id );
  }

declare()

template<class BASE >

void DataHandleHolderBase< BASE >::declare ( Gaudi::DataHandle &  handle )

inlineoverride

Definition at line 47 of file DataHandleHolderBase.h.

                                                   {
    if ( !handle.owner() ) handle.setOwner( this );
 
    if ( handle.owner() != this ) {
      throw GaudiException( "Attempt to declare foreign handle with algorithm!", this->name(), StatusCode::FAILURE );
    }
 
    m_handles.insert( &handle );
  }

extraInputDeps()

template<class BASE >

virtual const DataObjIDColl& DataHandleHolderBase< BASE >::extraInputDeps ( ) const

inlineoverridevirtual

Definition at line 44 of file DataHandleHolderBase.h.

{ return m_extInputDataObjs; }

extraOutputDeps()

template<class BASE >

virtual const DataObjIDColl& DataHandleHolderBase< BASE >::extraOutputDeps ( ) const

inlineoverridevirtual

Definition at line 45 of file DataHandleHolderBase.h.

{ return m_extOutputDataObjs; }

initDataHandleHolder()

template<class BASE >

void DataHandleHolderBase< BASE >::initDataHandleHolder ( )

inlineprotected

initializes all handles - called by the sysInitialize method of any descendant of this

Definition at line 93 of file DataHandleHolderBase.h.

                              {
    for ( auto h : m_handles ) h->init();
  }

inputDataObjs()

template<class BASE >

const DataObjIDColl& DataHandleHolderBase< BASE >::inputDataObjs ( ) const

inlineoverride

Definition at line 82 of file DataHandleHolderBase.h.

{ return m_inputDataObjs; }

inputHandles()

template<class BASE >

std::vector<Gaudi::DataHandle*> DataHandleHolderBase< BASE >::inputHandles ( ) const

inlineoverride

Definition at line 37 of file DataHandleHolderBase.h.

                                                            {
    return handles( m_handles, Gaudi::DataHandle::Reader );
  }

outputDataObjs()

template<class BASE >

const DataObjIDColl& DataHandleHolderBase< BASE >::outputDataObjs ( ) const

inlineoverride

Definition at line 83 of file DataHandleHolderBase.h.

{ return m_outputDataObjs; }

outputHandles()

template<class BASE >

std::vector<Gaudi::DataHandle*> DataHandleHolderBase< BASE >::outputHandles ( ) const

inlineoverride

Definition at line 40 of file DataHandleHolderBase.h.

                                                             {
    return handles( m_handles, Gaudi::DataHandle::Writer );
  }

renounce()

template<class BASE >

void DataHandleHolderBase< BASE >::renounce ( Gaudi::DataHandle &  handle )

inlineoverride

Definition at line 57 of file DataHandleHolderBase.h.

                                                    {
    if ( handle.owner() != this ) {
      throw GaudiException( "Attempt to renounce foreign handle with algorithm!", this->name(), StatusCode::FAILURE );
    }
    m_handles.erase( &handle );
  }

renounceInput()

template<class BASE >

bool DataHandleHolderBase< BASE >::renounceInput ( const DataObjID &  id )

inlineoverride

Definition at line 64 of file DataHandleHolderBase.h.

                                                     {
    bool renounced = false;
    // TODO: C++20: use std::erase_if
    for ( auto i = m_handles.begin(), last = m_handles.end(); i != last; ) {
      if ( ( *i )->mode() == Gaudi::DataHandle::Reader && ( *i )->fullKey() == id ) {
        i         = m_handles.erase( i );
        renounced = true;
      } else {
        ++i;
      }
    }
    if ( auto elm = m_inputDataObjs.find( id ); elm != m_inputDataObjs.end() ) {
      m_inputDataObjs.erase( elm );
      renounced = true;
    }
    return renounced;
  }

Member Data Documentation

m_extInputDataObjs

template<class BASE >

Gaudi::Property<DataObjIDColl> DataHandleHolderBase< BASE >::m_extInputDataObjs { this, "ExtraInputs", DataObjIDColl{} }

private

Definition at line 102 of file DataHandleHolderBase.h.

m_extOutputDataObjs

template<class BASE >

Gaudi::Property<DataObjIDColl> DataHandleHolderBase< BASE >::m_extOutputDataObjs { this, "ExtraOutputs", DataObjIDColl{} }

private

Definition at line 103 of file DataHandleHolderBase.h.

m_handles

template<class BASE >

std::unordered_set<Gaudi::DataHandle*> DataHandleHolderBase< BASE >::m_handles

private

Definition at line 100 of file DataHandleHolderBase.h.

m_inputDataObjs

template<class BASE >

DataObjIDColl DataHandleHolderBase< BASE >::m_inputDataObjs

protected

Definition at line 97 of file DataHandleHolderBase.h.

m_outputDataObjs

template<class BASE >

DataObjIDColl DataHandleHolderBase< BASE >::m_outputDataObjs

protected

Definition at line 97 of file DataHandleHolderBase.h.

---

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

• GaudiKernel/include/GaudiKernel/DataHandleHolderBase.h