WriteDecorHandleKey.cxx

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration.
 */
 
 
#include "StoreGate/WriteDecorHandleKey.h"
#include "GaudiKernel/IAlgTool.h"
#include "GaudiKernel/IDataHandleHolder.h"
#include "GaudiKernel/Algorithm.h"
 
 
namespace SG {
namespace detail {
 

bool handleInHolder (const DataObjID& contHandleKey,
                     const IDataHandleHolder& holder)
{
  for (const Gaudi::DataHandle* h : holder.inputHandles()) {
    if (h->fullKey() == contHandleKey) {
      return true;
    }
  }
 
  for (const Gaudi::DataHandle* h : holder.outputHandles()) {
    if (h->fullKey() == contHandleKey) {
      return true;
    }
  }
 
  return false;
}
 

const IDataHandleHolder* findParent (const IDataHandleHolder* h)
{
  while (true) {
    const IAlgTool* astool = dynamic_cast<const IAlgTool*> (h);
    if (!astool) return h;
    const IInterface* parent = astool->parent();
    if (!parent) return h;
    auto pdh = dynamic_cast<const IDataHandleHolder*> (parent);
    if (!pdh) return h;
    if (dynamic_cast<const Gaudi::Algorithm*> (parent)) return pdh;
    h = pdh;
  }
}
 

class WDHScan
  : public IDataHandleVisitor
{
public:
  WDHScan (const DataObjID& contHandleKey, const IDataHandleHolder* owner)
    : m_contHandleKey (contHandleKey),
      m_owner (owner)
  {
  }

  virtual void visit (const IDataHandleHolder* h) override;

  const DataObjID& m_contHandleKey;

  const IDataHandleHolder* m_owner;

  bool m_found = false;

  bool m_sawOwner = false;
};
 

void WDHScan::visit (const IDataHandleHolder* h)
{
  // Don't do anything if we've already found the key, or if we've seen m_owner.
  if (m_found || m_sawOwner) return;
  if (h == m_owner) {
    m_sawOwner = true;
    return;
  }
 
  // Test to see if this component has a key matching the one we're looking for.
  m_found = handleInHolder (m_contHandleKey, *h);
}
 

void registerWriteDecorHandleKey (IDataHandleHolder* owner,
                                  const DataObjID& contHandleKey)
{
  if (!owner) return;
 
  // Does this component already have a key matching @c contHandleKey?
  bool found = handleInHolder (contHandleKey, *owner);
 
  if (!found) {
    // No --- now search the complete component tree up to @c owner for a match.
    const IDataHandleHolder* parent = findParent (owner);
    if (parent && parent != owner) {
      WDHScan scan (contHandleKey, owner);
      parent->acceptDHVisitor (&scan);
      found = scan.m_found;
    }
  }
 
  if (!found) {
    owner->addDependency (contHandleKey, Gaudi::DataHandle::Reader);
  }
}
 
 
} // namespace detail
} // namespace SG