DHHVisitor Class Reference

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

Inheritance diagram for DHHVisitor:

Collaboration diagram for DHHVisitor:

Public Types
using	Owners = std::vector<const IDataHandleHolder*>

Public Member Functions
	DHHVisitor (DataObjIDColl &ido, DataObjIDColl &odo)
const DataObjIDColl &	ignoredInpKeys () const
const DataObjIDColl &	ignoredOutKeys () const
void	visit (const IDataHandleHolder *visitee) override
const std::map< DataObjID, std::set< const IDataHandleHolder * > > &	owners () const
std::vector< const IDataHandleHolder * >	owners_of (const DataObjID &id) const
std::vector< std::string >	owners_names_of (const DataObjID &id, bool with_main=false) const
bool	empty () const
	return true if no DataHandle was found
Public Member Functions inherited from IDataHandleVisitor
virtual	~IDataHandleVisitor ()=default

Private Member Functions
MsgStream &	report (MsgStream &stream) const

Private Attributes
DataObjIDColl &	m_ido
DataObjIDColl &	m_odo
DataObjIDColl	m_ign_i
DataObjIDColl	m_ign_o
std::map< DataObjID, std::set< const IDataHandleHolder * > >	m_owners
std::string	m_initialName

Friends
MsgStream &	operator<< (MsgStream &stream, const DHHVisitor &visitor)

Detailed Description

Definition at line 20 of file DataHandleHolderVisitor.h.

Member Typedef Documentation

Owners

using DHHVisitor::Owners = std::vector<const IDataHandleHolder*>

Definition at line 22 of file DataHandleHolderVisitor.h.

Constructor & Destructor Documentation

DHHVisitor()

DHHVisitor::DHHVisitor	(	DataObjIDColl &	ido,
		DataObjIDColl &	odo )

Definition at line 24 of file DataHandleHolderVisitor.cpp.

: m_ido( ido ), m_odo( odo ) {}

Member Function Documentation

empty()

bool DHHVisitor::empty

(

)

const

return true if no DataHandle was found

Definition at line 122 of file DataHandleHolderVisitor.cpp.

                             {
  // any data handle would have as side effect to add something to m_owners,
  // so it's enough to check this instead of all the other containers
  return m_owners.empty();
}

ignoredInpKeys()

const DataObjIDColl & DHHVisitor::ignoredInpKeys ( ) const

inline

Definition at line 26 of file DataHandleHolderVisitor.h.

{ return m_ign_i; }

ignoredOutKeys()

const DataObjIDColl & DHHVisitor::ignoredOutKeys ( ) const

inline

Definition at line 27 of file DataHandleHolderVisitor.h.

{ return m_ign_o; }

owners()

const std::map< DataObjID, std::set< const IDataHandleHolder * > > & DHHVisitor::owners ( ) const

inline

Definition at line 31 of file DataHandleHolderVisitor.h.

{ return m_owners; }

owners_names_of()

std::vector< std::string > DHHVisitor::owners_names_of	(	const DataObjID &	id,
		bool	with_main = false ) const

Definition at line 82 of file DataHandleHolderVisitor.cpp.

                                                                                            {
  std::vector<std::string> tmp;
  for ( auto owner : owners_of( id ) ) {
    if ( with_main || owner->name() != m_initialName ) tmp.push_back( owner->name() );
  }
  if ( !tmp.empty() ) { std::sort( tmp.begin(), tmp.end() ); }
  return tmp;
}

owners_of()

std::vector< const IDataHandleHolder * > DHHVisitor::owners_of

(

const DataObjID &

id

)

const

Definition at line 75 of file DataHandleHolderVisitor.cpp.

                                                                                     {
  if ( auto item = m_owners.find( id ); item != m_owners.end() ) {
    return { item->second.begin(), item->second.end() };
  }
  return {};
}

report()

MsgStream & DHHVisitor::report ( MsgStream & stream ) const

private

Definition at line 91 of file DataHandleHolderVisitor.cpp.

                                                       {
  // sort DataObjects by path so that logging is reproducible
  // we define a little helper creating an ordered set from a non ordered one
  auto sort     = []( const DataObjID& a, const DataObjID& b ) -> bool { return a.fullKey() < b.fullKey(); };
  auto orderset = [&sort]( const DataObjIDColl& in ) -> std::set<DataObjID, decltype( sort )> {
    return { in.begin(), in.end(), sort };
  };
  auto write_owners_of = [this]( auto& stream, const DataObjID& id ) {
    auto tmp = owners_names_of( id );
    if ( !tmp.empty() ) { stream << ' ' << tmp; }
  };
 
  for ( auto h : orderset( m_ido ) ) {
    stream << "\n  + INPUT  " << h;
    write_owners_of( stream, h );
  }
  for ( auto id : orderset( m_ign_i ) ) {
    stream << "\n  + INPUT IGNORED " << id;
    write_owners_of( stream, id );
  }
  for ( auto h : orderset( m_odo ) ) {
    stream << "\n  + OUTPUT " << h;
    write_owners_of( stream, h );
  }
  for ( auto id : orderset( m_ign_o ) ) {
    stream << "\n  + OUTPUT IGNORED " << id;
    write_owners_of( stream, id );
  }
  return stream;
}

visit()

void DHHVisitor::visit ( const IDataHandleHolder * visitee )

overridevirtual

Implements IDataHandleVisitor.

Definition at line 26 of file DataHandleHolderVisitor.cpp.

                                                   {
  if ( !v ) { return; }
 
  // Record the name of the first IDataHandleHolder we encounter, for cleaner report
  if ( m_initialName.empty() ) m_initialName = v->name();
 
  // Loop over inputs and outputs of handles, extra dependiencies and objects to
  // collect all of them.
  // Handles and extra dependencies are those of a specific algorith or tool, while
  // the collection of data objects also contains those of the tree of tools and
  // algorithms below it.
 
  // Loop over input handles and output handles and store those with with non-empty keys
  // in the container of input objects passed to us and the others in a container of those
  // we ignore for debug purposes. To avoid multiple for loops, make some tuples and loop
  // over those.
  for ( auto& hs : { make_tuple( v->inputHandles(), std::ref( m_ido ), std::ref( m_ign_i ) ),
                     make_tuple( v->outputHandles(), std::ref( m_odo ), std::ref( m_ign_o ) ) } ) {
    for ( const auto& h : std::get<0>( hs ) ) {
      if ( !h->objKey().empty() ) {
        std::get<1>( hs ).emplace( h->fullKey() );
      } else {
        std::get<2>( hs ).emplace( h->fullKey() );
      }
      m_owners[h->fullKey()].emplace( v );
    }
  }
 
  for ( auto& id : v->extraInputDeps() ) { m_owners[id].emplace( v ); }
  for ( auto& id : v->extraOutputDeps() ) { m_owners[id].emplace( v ); }
 
  // The containers of handles are a different type than the on of input deps and input
  // objects, so we need another loop here.
  // NOTE: perhaps a view from range v3 can be used to also avoid this second loop.
  for ( auto& hs : { make_tuple( v->extraInputDeps(), std::ref( m_ido ), std::ref( m_ign_i ) ),
                     make_tuple( v->extraOutputDeps(), std::ref( m_odo ), std::ref( m_ign_o ) ),
                     make_tuple( v->inputDataObjs(), std::ref( m_ido ), std::ref( m_ign_i ) ),
                     make_tuple( v->outputDataObjs(), std::ref( m_odo ), std::ref( m_ign_o ) ) } ) {
    for ( const auto& h : std::get<0>( hs ) ) {
      if ( !h.key().empty() ) {
        std::get<1>( hs ).emplace( h );
      } else {
        std::get<2>( hs ).emplace( h );
      }
      m_owners[h].emplace( v );
    }
  }
}

Friends And Related Symbol Documentation

operator<<

MsgStream & operator<< ( MsgStream & stream, const DHHVisitor & visitor )

friend

Definition at line 50 of file DataHandleHolderVisitor.h.

{ return visitor.report( stream ); }

Member Data Documentation

m_ido

DataObjIDColl& DHHVisitor::m_ido

private

Definition at line 41 of file DataHandleHolderVisitor.h.

m_ign_i

DataObjIDColl DHHVisitor::m_ign_i

private

Definition at line 42 of file DataHandleHolderVisitor.h.

m_ign_o

DataObjIDColl DHHVisitor::m_ign_o

private

Definition at line 42 of file DataHandleHolderVisitor.h.

m_initialName

std::string DHHVisitor::m_initialName

private

Definition at line 46 of file DataHandleHolderVisitor.h.

m_odo

DataObjIDColl & DHHVisitor::m_odo

private

Definition at line 41 of file DataHandleHolderVisitor.h.

m_owners

std::map<DataObjID, std::set<const IDataHandleHolder*> > DHHVisitor::m_owners

private

Definition at line 44 of file DataHandleHolderVisitor.h.

---

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

• GaudiKernel/include/GaudiKernel/DataHandleHolderVisitor.h
• GaudiKernel/src/Lib/DataHandleHolderVisitor.cpp