MeVis/Foundation/Sources/MLBackgroundTasks/mlBackgroundTaskBaseModule.h

Go to the documentation of this file.

// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------


#ifndef __mlBackgroundTaskBaseModule_H
#define __mlBackgroundTaskBaseModule_H


// Local includes
#include "MLBackgroundTasksSystem.h"

// ML includes
#include "mlModuleIncludes.h"

#include "mlModuleBackgroundTask.h"
#include "mlBackgroundTaskManager.h"

ML_START_NAMESPACE

class MLBACKGROUNDTASKS_EXPORT BackgroundTaskBaseModule : public Module
{
public:
  enum ExecutionMode {
    Synchronous, 
    Asynchronous 
  };

  BackgroundTaskBaseModule();
  BackgroundTaskBaseModule(int n, int m);
  ~BackgroundTaskBaseModule();

  virtual void handleNotification (Field *field);

  virtual void taskFinished(BackgroundTask* task);

  virtual void postTaskFinished();

  virtual ModuleBackgroundTask* createTask() = 0;

  virtual void updateFinishedTaskStatus(BackgroundTask* task);

  void startTask() { startTask(Asynchronous); };

  void startTask(const ExecutionMode mode);

  void cancelTask();

  bool hasRunningTask();

  bool willRestartTask() { return _restartTask; }

  void setRestartTask(bool flag) { _restartTask = flag; }

private:
  void preTaskFinished();

  static void taskFinishedCB(void* userData, BackgroundTask* task);

  void init();

protected:
  // ----------------------------------------------------------

  // ----------------------------------------------------------

  NotifyField *_startTask;

  NotifyField *_startTaskSynchronous;

  NotifyField *_cancelTask;

  FloatField  *_progress;

  StringField *_status;

  BoolField   *_taskRunning;

  NotifyField *_taskFinished;

  NotifyField *_taskCanceled;

  BoolField   *_taskVerboseLogging;


private:
  BackgroundTaskHandle _taskHandle;

  bool _restartTask;

  ML_ABSTRACT_MODULE_CLASS_HEADER(BackgroundTaskBaseModule)

};


ML_END_NAMESPACE

#endif // __mlBackgroundTaskBaseModule_H