source: pacpusframework/trunk/include/Pacpus/PacpusTools/PeriodicWorker.h@ 36

/**
 *
 * This file is part of the PACPUS framework distributed under the 
 * CECILL-C License, Version 1.0.
 * 
 * @author  Samuel Gosselin
 * @date    December, 2012
 * @version $Id$
 * @copyright Copyright (c) UTC/CNRS Heudiasyc 2005 - 2013. All rights reserved.
 * @brief  Periodic worker base class
 *
 * Detailed description of file...
 * 
 */

#ifndef DEF_PACPUS_PERIODIC_WORKER_H
#define DEF_PACPUS_PERIODIC_WORKER_H

// Includes, pacpus.
#include <Pacpus/PacpusTools/AsyncWorkerBase.h>

class QTimer;

namespace pacpus
{
  /** PeriodicWorker
   * @brief A simple base class for periodic worker.
   *
   * @example
   *    class MyWorker
   *      : public PeriodicWorkder
   *    {
   *      public:
   *        void doWork() { std::cout << "Hey, I'm working!" << std::endl; }
   *    };
   *
   *    // Do its work every second.
   *    MyWorker worker;
   *    worker.startWork(1000);
   */
  class PeriodicWorker
    : public AsyncWorkerBase
  {
    Q_OBJECT
    public:
      /// Ctor of PeriodicWorker.
      PeriodicWorker();
      
      /// Dtor of PeriodicWorker.
      virtual ~PeriodicWorker();
      
      /** Start the periodic worker.
       * @param msec Period in mseconds.
       */
      void startWork(int msec);
      
      /** Stop the periodic worker, but do not delete it. */
      void stopWork();
      
    public slots:
      /** Do the work.
       * This method need to be implemented in the subclasses, it will be called
       * each time the timer has reached its period.
       */
      virtual void doWork() = 0;
      
    private:
      QTimer* mHeartbeat;
  };
}

#endif // DEF_PACPUS_PERIODIC_WORKER_H