Algorithm.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef EVENT_LOOP_ALGORITHM_HH
#define EVENT_LOOP_ALGORITHM_HH
 
 
#include <EventLoop/Global.h>
 
#include <TNamed.h>
#include <AsgMessaging/INamedInterface.h>
#include <AsgTools/SgEvent.h>
#include <EventLoop/StatusCode.h>
 
class TH1;
class MsgStream;
 
namespace EL
{
  class Algorithm : public TNamed, public INamedInterface
  {
    //
    // public interface
    //

  public:
    void testInvariant () const;
 

  public:
    Algorithm ();
 

  public:
    ~Algorithm ();
 
    // we never copy algorithms, they get created using TObject::Clone()
    // and their dicitionary
  public:
    Algorithm (const Algorithm&) = delete;
    Algorithm& operator = (const Algorithm&) = delete;
 

  public:
    IWorker *wk () const;
 

  public:
    void book (const TH1& hist);
 

  public:
    TH1 *hist (const std::string& name) const;
 

  public:
    asg::SgEvent *evtStore() const;
 
 


  public:
    MsgStream& msg () const;
 

  public:
    MsgStream& msg (int level) const;
 

  public:
    bool msgLvl (int lvl) const;
 

  public:
    void setMsgLevel (int level);

 
 
 
    //
    // virtual interface
    //

  private:
    virtual StatusCode setupJob (Job& job);
 

  private:
    virtual StatusCode fileExecute ();
 

  private:
    virtual StatusCode endOfFile ();
 

  private:
    virtual StatusCode changeInput (bool firstFile);
 

  private:
    virtual StatusCode initialize ();
 

  private:
    virtual StatusCode histInitialize ();
 

  private:
    virtual StatusCode execute ();
 

  private:
    virtual StatusCode postExecute ();
 

  private:
    virtual StatusCode finalize ();
 

  private:
    virtual StatusCode histFinalize ();
 

  private:
    virtual bool hasName (const std::string& name) const;
 
 
 
    //
    // inherited interface
    //
 
  public:
    virtual const std::string& name() const;
 
 
    //
    // friend interface for Job
    //
 
    friend class AlgorithmWrapper;
    friend class Job;
  private:

    void sysSetupJob (Job& job);
 
 
 
    //
    // private interface
    //
 
    // description: members directly corresponding to accessors
  private:
    IWorker *m_wk; 

  private:
    mutable asg::SgEvent *m_evtStorePtr = nullptr; 

  private:
    mutable asg::SgEvent m_evtStore; 

  private:
    mutable MsgStream *m_msg = nullptr; 

  private:
    mutable std::string m_msgName; 

  private:
    int m_msgLevel = 3;

  private:
    mutable std::string m_nameCache; 
 
    ClassDef(Algorithm, 1);
  };
}
 
#endif