AthAlgStartVisitor Class Reference

Call start() on all ReadCondHandle's of an algorithm. More...

#include <AthAlgStartVisitor.h>

Inheritance diagram for AthAlgStartVisitor:

Collaboration diagram for AthAlgStartVisitor:

Public Member Functions
virtual void	visit (const IDataHandleHolder *holder) override
	Visit a component and start() any read conditions handles. More...
	AthAlgStartVisitor ()=default
	AthAlgStartVisitor (INamedInterface *)
	Figure out where we're called from. More...

Private Attributes
std::unordered_set< const IDataHandleHolder * >	m_seen
	figure out where we're called from More...
bool	m_recursive {true}
bool	m_ignore {false}
	process recursively (for Algs) More...

Detailed Description

Call start() on all ReadCondHandle's of an algorithm.

For efficient conditions handling, a CondHandleKey needs to cache a pointer to the conditions container. initialize() is too early for this as conditions containers made by CondInputLoader are not created until start(). So during the start() of an algorithm, we visit all read conditions handle keys and call start() on them, to give them the opportunity to look up the conditions object.

We use IDataHandleVisitor to do this recursively for all owned tools as well.

FIXME: this should probably be moved to GaudiKernel, and have all AlgTools started by their parent Algorithms

Definition at line 39 of file AthAlgStartVisitor.h.

Constructor & Destructor Documentation

AthAlgStartVisitor() [1/2]

AthAlgStartVisitor::AthAlgStartVisitor ( )

default

AthAlgStartVisitor() [2/2]

AthAlgStartVisitor::AthAlgStartVisitor

(

INamedInterface *

n

)

Figure out where we're called from.

Only want to process holders recursively if caller is a real Algorithm. If it's an AlgTool, don't recurse. If it's a Sequence, don't do anything.

Parameters

n	back pointer to parent

Definition at line 26 of file AthAlgStartVisitor.cxx.

                                                         {
  // only do recursive traversal if we are called from a real Algorithm
  IAlgorithm* ia = dynamic_cast<IAlgorithm*>(n);
  if ( ia == nullptr) {
    m_recursive = false;
  } else if ( ia->isSequence() ) {
    m_recursive = false;
    m_ignore = true;
  }
}

Member Function Documentation

visit()

void AthAlgStartVisitor::visit ( const IDataHandleHolder *  holder )

overridevirtual

Visit a component and start() any read conditions handles.

Parameters

holder

The component to visit.

Definition at line 42 of file AthAlgStartVisitor.cxx.

{
  if (m_ignore) return;
 
  // Make sure we process a component only once.
  if (m_seen.insert (holder).second) {
 
    // Check all input handles are initialised
    for (Gaudi::DataHandle* h : holder->inputHandles()) {
 
      auto vhk = dynamic_cast<SG::VarHandleKey*> (h);
      if (!vhk) throw SG::ExcNullHandleKey();
 
      if (!vhk->storeHandle().get() && !vhk->key().empty()) {
        throw SG::ExcUninitKey (vhk->clid(), vhk->key(), vhk->storeHandle().name(), holder->name());
      }
 
      // Call start() on all read conditions handle keys.
      if (h->isCondition()) {
        vhk->start().ignore();
      }
    }
 
    // Check all output handles are initialised
    for (Gaudi::DataHandle* h : holder->outputHandles()) {
 
      auto vhk = dynamic_cast< SG::VarHandleKey* > (h);
      if (!vhk) throw SG::ExcNullHandleKey();
 
      if (!vhk->storeHandle().get() && !vhk->key().empty()) {
        throw SG::ExcUninitKey (vhk->clid(), vhk->key(), vhk->storeHandle().name(), holder->name());
      }
    }
 
    if (m_recursive) {
      holder->acceptDHVisitor (this);
    }
  }
}

Member Data Documentation

m_ignore

bool AthAlgStartVisitor::m_ignore {false}

private

process recursively (for Algs)

Definition at line 56 of file AthAlgStartVisitor.h.

m_recursive

bool AthAlgStartVisitor::m_recursive {true}

private

Definition at line 55 of file AthAlgStartVisitor.h.

m_seen

std::unordered_set<const IDataHandleHolder*> AthAlgStartVisitor::m_seen

private

figure out where we're called from

Keep track of components we've already processed.

Definition at line 54 of file AthAlgStartVisitor.h.

---

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

• AthAlgStartVisitor.h
• AthAlgStartVisitor.cxx