AlgSnarl.h

Go to the documentation of this file.

#ifndef ANP_ALGSNARL_H
#define ANP_ALGSNARL_H

//
// ABC for snarl based algorithm
// 
// This algorithm is executed once for each snarl
//
//
// Five virtual functions
//
// Run() is executed on every snarl
//
// Config() is called after algorithm is created
//          it passed registry with configuration parameters
//
// Set() is called after Config()
//       it provides a pointer to TDirectory in ROOT file
//       TDirectory pointer can be NULL
//
// Init() is called once before Run() but after
//        Config() and Set()
//
// End() is called after processing is complete
//       after this call there no more snarls to Run()
//

// C++
#include <string>

// Local
#include "PhysicsNtuple/Handle.h"
#include "PhysicsNtuple/Record.h"

class DataBlock;
class Registry;
class TDirectory;

namespace Anp
{
   class AlgSnarl: public virtual Base
   {      
   public:      
      
      AlgSnarl();
      virtual ~AlgSnarl();

      virtual bool Run(Record &) = 0;

      virtual void Config(const Registry &);

      virtual void Set(TDirectory *);

      virtual bool Init(const Header &);

      virtual void End(const DataBlock &);

      void Name(const std::string &value);
      const std::string& Name() const;

   private:
      
      AlgSnarl(const AlgSnarl &);
      AlgSnarl& operator=(const AlgSnarl &);
    
   private:

      std::string fName;

   };

   typedef Anp::Handle<Anp::AlgSnarl> AlgSnarlPtr;

   //
   // Inlined member functions
   //

   inline AlgSnarl::AlgSnarl() : fName("generic")
   {
   }

   inline AlgSnarl::~AlgSnarl()
   {
   }

   inline void AlgSnarl::Config(const Registry &)
   {
   }

   inline void AlgSnarl::Set(TDirectory *)
   { 
   }

   inline bool AlgSnarl::Init(const Header &)
   {
      return true;
   }

   inline void AlgSnarl::End(const DataBlock &)
   { 
   }

   inline void AlgSnarl::Name(const std::string &value)
   { 
      fName = value;
   }

   inline const std::string& AlgSnarl::Name() const
   {
      return fName;
   }
}

#endif

---