ATLAS Offline Software
Public Types | Public Member Functions | List of all members
columnar::TestUtils::IXAODToolCaller Class Referenceabstract

a wrapper around a CP tool in xAOD mdoe to call it in the PHYSLITE test More...

#include <IXAODToolCaller.h>

Collaboration diagram for columnar::TestUtils::IXAODToolCaller:

Public Types

using EventStoreType = std::decay_t< decltype(*std::declval< asg::AsgTool >().evtStore())>
 the type used for the event store More...
 

Public Member Functions

virtual ~IXAODToolCaller () noexcept=default
 
virtual StatusCode retrieve (EventStoreType &evtStore)=0
 retrieve everything we need from the event store More...
 
virtual StatusCode copyRecord (EventStoreType &evtStore, const std::string &postfix)=0
 do any copying and recording needed More...
 
virtual StatusCode call ()=0
 call the tool for a single event More...
 

Detailed Description

a wrapper around a CP tool in xAOD mdoe to call it in the PHYSLITE test

This goes through the different steps needed to call a tool. For regular use, those are normally part of a single algorithm execute function, but splitting them up allows to measure their performance separately.

It is expected that the instances of this interface will cache information between calls. That is safe as no function is const and this will never run in multi-threaded mode. It provides the easiest way to store what in an algorithm would be local variables.

Definition at line 31 of file IXAODToolCaller.h.

Member Typedef Documentation

◆ EventStoreType

using columnar::TestUtils::IXAODToolCaller::EventStoreType = std::decay_t<decltype (*std::declval<asg::AsgTool>().evtStore())>

the type used for the event store

Definition at line 37 of file IXAODToolCaller.h.

Constructor & Destructor Documentation

◆ ~IXAODToolCaller()

virtual columnar::TestUtils::IXAODToolCaller::~IXAODToolCaller ( )
virtualdefaultnoexcept

Member Function Documentation

◆ call()

virtual StatusCode columnar::TestUtils::IXAODToolCaller::call ( )
pure virtual

call the tool for a single event

◆ copyRecord()

virtual StatusCode columnar::TestUtils::IXAODToolCaller::copyRecord ( EventStoreType evtStore,
const std::string &  postfix 
)
pure virtual

do any copying and recording needed

◆ retrieve()

virtual StatusCode columnar::TestUtils::IXAODToolCaller::retrieve ( EventStoreType evtStore)
pure virtual

retrieve everything we need from the event store


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