ATLAS Offline Software
Public Member Functions | List of all members
EL::IHistogramWorker Class Referenceabstract

the interface to histogram storage on the worker More...

#include <IHistogramWorker.h>

Inheritance diagram for EL::IHistogramWorker:
Collaboration diagram for EL::IHistogramWorker:

Public Member Functions

virtual ~IHistogramWorker () noexcept=default
 standard (virtual) destructor More...
 
virtual void addOutput (TObject *output_swallow)=0
 effects: add an object to the output. More...
 
virtual TObject * getOutputHist (const std::string &name) const =0
 get the output histogram with the given name More...
 

Detailed Description

the interface to histogram storage on the worker

This interface summarizes the subset of Worker that is needed for generating outputs.

Definition at line 29 of file IHistogramWorker.h.

Constructor & Destructor Documentation

◆ ~IHistogramWorker()

virtual EL::IHistogramWorker::~IHistogramWorker ( )
virtualdefaultnoexcept

standard (virtual) destructor

Guarantee
no-fail

Member Function Documentation

◆ addOutput()

virtual void EL::IHistogramWorker::addOutput ( TObject *  output_swallow)
pure virtual

effects: add an object to the output.

the worker takes over ownership of the object, but the caller may maintain a reference to it guarantee: basic, argument is always swallowed failures: out of memory I requires: output_swallow != 0 warning: so far I placed no requirements on the output objects. I may do that at a later stage though, possibly breaking existing code.

Implemented in EL::Worker.

◆ getOutputHist()

virtual TObject* EL::IHistogramWorker::getOutputHist ( const std::string &  name) const
pure virtual

get the output histogram with the given name

This is mostly meant, so that I can emulate the Athena histogram mechanism.

Guarantee
strong
Failures
object not found
Postcondition
result != 0

Implemented in EL::Worker.


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