R_algo.h

Go to the documentation of this file.

#ifndef TRAPPER_R_ALGO_H
#define TRAPPER_R_ALGO_H

#include "algo.h"
#include "mal_readonly.h"

/** \brief Base class for algorithms that reads data. Nota bene! Read-only!
    
     Derive from this class if you want to write an algorithm which
     only need read access to the data.

     The MAl_readonly functionality is provided by the
     getMAl() function.

     SOP for creating a new R algorithm (called NewAlgo in this
     example):

     newalgo.h (#include guards etc omitted):

     \code
     #include "R_algo.h"

     class NewAlgo : public RAlgo
     {
     public:
       NewAlgo(TrapperDoc * pDoc_, std::set< db_recno_t >& recnoList, AlgoParam* param) : 
       RAlgo(pDoc_, recnoList, param) {}
     
       void start();
  
     };
     \endcode

     That's it. The new algo implements the start() function and has to call RAlgo's
     only constructor. start() can be virtual if a family of algos are being constructed.

     NOTA BENE! Important that the constructor gets a reference to the recnolist!

     newalgo.cpp:
     
     \code
     #include "newalgo.h"
     
     void NewAlgo::start()
     {
       //implementation of NewAlgo::start().
     }

     \endcode
     

     newalgomaker.cpp:

     \code
     #include "algomaker.h"
     #include "newalgo.h"

     char newAlgo[]="New Algo";//The text that shows up in the popup
     const bool newPopsup = true;//true if it should pop up in context menu
     template
     const AlgoMakerTP< NewAlgo, newAlgo, newPopsup > AlgoMakerTP< NewAlgo, newAlgo, newPopsup >::registerThis;
     \endcode

     Add the new files to src.pro and you're done.
*/
class RAlgo : public Algo
{
public:
  RAlgo(TrapperDoc * pDoc_, std::set< db_recno_t >& recnoList, AlgoParam* param);
  ~RAlgo() { delete mal; }

  virtual void start() = 0;
  
  MAl_Readonly* getMAl() { return mal; }
  
private:
  MAl_Readonly* mal;
};

#endif// TRAPPER_R_ALGO_H

---