AthenaBaseComps::AthAlgorithmDHUpdate Class Reference

Update output dependencies to include symlinks. More...

#include <AthAlgorithmDHUpdate.h>

Inheritance diagram for AthenaBaseComps::AthAlgorithmDHUpdate:

Collaboration diagram for AthenaBaseComps::AthAlgorithmDHUpdate:

Public Member Functions
	AthAlgorithmDHUpdate (DataObjIDColl &linkedObjs, std::unique_ptr< IDataHandleVisitor > chain)
	Constructor. More...
virtual void	visit (const IDataHandleHolder *dhh) override
	Walk over the dependencies of an algorithm. More...

Private Member Functions
void	handle (CLID clid, const std::string &key)
	Handle one output dependency. More...

Private Attributes
DataObjIDColl &	m_linkedObjs
	Set of additional output dependencies represented by links. More...
std::unique_ptr< IDataHandleVisitor >	m_chain
	Hook to call after this one. More...

Detailed Description

Update output dependencies to include symlinks.

This is intended to be installed in an algorithm via the m_updateDataHandles hook, to run before Algorithm::sysInitialize merges the sets of input and output dependencies.

It makes a first pass over all the output dependences. For each, it examines the CLID to see if there are any other CLIDs to which it is convertable, and if so, adds them to the linkedObjs list. The intention is that the algorithm will then override extraOutputDeps so that it will include these extra entries.

Definition at line 40 of file AthAlgorithmDHUpdate.h.

Constructor & Destructor Documentation

AthAlgorithmDHUpdate()

AthenaBaseComps::AthAlgorithmDHUpdate::AthAlgorithmDHUpdate	(	DataObjIDColl &	linkedObjs,
		std::unique_ptr< IDataHandleVisitor >	chain
	)

Constructor.

Parameters

linkedObjs	Set to which entries for symlinks will be added.
chain	Hook to call after this one completes.

Definition at line 25 of file AthAlgorithmDHUpdate.cxx.

  : m_linkedObjs (linkedObjs),
    m_chain (std::move (chain))
{
}

Member Function Documentation

handle()

void AthenaBaseComps::AthAlgorithmDHUpdate::handle ( CLID  clid, const std::string &  key  )

private

Handle one output dependency.

Parameters

clid	The CLID of the output.
key	The SG key of the output.

If CLID has symlinks available, enter these links in linkedObjs.

Definition at line 81 of file AthAlgorithmDHUpdate.cxx.

{
  const SG::BaseInfoBase* bib = SG::BaseInfoBase::find (clid);
  if (!bib) return;
  for (CLID clid2 : bib->get_bases()) {
    if (clid2 != clid) {
      m_linkedObjs.emplace (clid2, key);
    }
  }
}

visit()

void AthenaBaseComps::AthAlgorithmDHUpdate::visit ( const IDataHandleHolder *  dhh )

overridevirtual

Walk over the dependencies of an algorithm.

Parameters

dhh	The algorithm object.

Finds output dependencies of the algorithms that have symlinks available and enters these links in linkedObjs.

Definition at line 40 of file AthAlgorithmDHUpdate.cxx.

{
  // Make a copy, as usually linkedObjs will be extraOutputDeps().
  DataObjIDColl ex = dhh->extraOutputDeps();
 
  // Process all output dependencies.
  for (const Gaudi::DataHandle* h : dhh->outputHandles()) {
    if (!h->objKey().empty())
      handle (h->fullKey().clid(), h->objKey());
  }
 
  for (const DataObjID& dobj : ex) {
    if (!dobj.key().empty())
      handle (dobj.clid(), dobj.key());
  }
 
  for (const DataObjID& dobj : dhh->outputDataObjs()) {
    if (!dobj.key().empty())
      handle (dobj.clid(), dobj.key());
  }
 
  // If we put anything in linkedObjs, also add the contents
  // of extraOutputDeps.
  if (!m_linkedObjs.empty()) {
    m_linkedObjs.insert (ex.begin(), ex.end());
  }
 
  // Call the next hook function, if any.
  if (m_chain) {
    m_chain->visit (dhh);
  }
}

Member Data Documentation

m_chain

std::unique_ptr<IDataHandleVisitor> AthenaBaseComps::AthAlgorithmDHUpdate::m_chain

private

Hook to call after this one.

Definition at line 78 of file AthAlgorithmDHUpdate.h.

m_linkedObjs

DataObjIDColl& AthenaBaseComps::AthAlgorithmDHUpdate::m_linkedObjs

private

Set of additional output dependencies represented by links.

Definition at line 75 of file AthAlgorithmDHUpdate.h.

---

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

• AthAlgorithmDHUpdate.h
• AthAlgorithmDHUpdate.cxx