RW_algo.h

Go to the documentation of this file.

#ifndef TRAPPER_RW_ALGO_H
#define TRAPPER_RW_ALGO_H

#include "algo.h"
#include "mal.h"

/** \brief Base class for algorithms that reads and writes data
    
     Derive from this class if you want to write an algorithm which
     modifies the data in some way. Changes made to the data via the
     MAl interface will be automatically reflected in the database, 
     without the programmer having to worry about the DB.

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

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

     newalgo.h (#include guards etc omitted):

     \code
     #include "RW_algo.h"

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

     That's it. The new algo implements the start() function and has to call RWAlgo'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 RWAlgo : public Algo
{
public:
  RWAlgo(TrapperDoc * pDoc_, std::set< db_recno_t >& recnoList, AlgoParam* param);
  ~RWAlgo() { delete mal; }

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

#endif// TRAPPER_RW_ALGO_H

---