mlBackgroundTaskModuleHandler.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2009, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_BACKGROUND_TASK_MODULE_HANDLER_H
#define ML_BACKGROUND_TASK_MODULE_HANDLER_H
 
// Local includes
#include "MLBackgroundTasksSystem.h"
#include "mlModuleBackgroundTask.h"
#include "mlBackgroundTaskManager.h"
 
// ML includes
#include <mlModuleIncludes.h>
 
ML_START_NAMESPACE
 
class BackgroundTaskBaseModule;
 
class MLBACKGROUNDTASKS_EXPORT BackgroundTaskModuleHandler
{
public:

  enum ExecutionMode {
    Synchronous, 
    Asynchronous 
  };
 
  BackgroundTaskModuleHandler();
  virtual ~BackgroundTaskModuleHandler();
 
  virtual void setupTaskFields(Module* module);

  void setTaskRunningField(BoolField* taskRunningField) { _taskRunning = taskRunningField; }
  void setTaskFinishedField(NotifyField* taskFinishedField) { _taskFinished = taskFinishedField; }
  void setTaskCanceledField(NotifyField* taskCanceledField) { _taskCanceled = taskCanceledField; }
  void setTaskProgressField(FloatField* progressField) { _progress = progressField; }
  void setTaskStatusField(StringField* statusField) { _status = statusField; }
 
  NotifyField* getStartTaskField() { return _startTask; }
  NotifyField* getStartTaskSynchronousField() { return _startTaskSynchronous; }
  NotifyField* getCancelTaskField() { return _cancelTask; }
  BoolField*   getTaskVerboseLoggingField() { return _taskVerboseLogging; }
 
  BoolField*   getTaskRunningField() { return _taskRunning; }
  NotifyField* getTaskFinishedField() { return _taskFinished; }
  NotifyField* getTaskCanceledField() { return _taskCanceled; }
  FloatField*  getTaskProgressField() { return _progress; }
  StringField* getTaskStatusField() { return _status; }
 

  virtual void handleTaskFieldNotification(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);
 
protected:
  // ----------------------------------------------------------
  // ----------------------------------------------------------
  NotifyField *_startTask;
  NotifyField *_startTaskSynchronous;
  NotifyField *_cancelTask;
  FloatField  *_progress;
  StringField *_status;
  BoolField   *_taskRunning;
  NotifyField *_taskFinished;
  NotifyField *_taskCanceled;
  BoolField   *_taskVerboseLogging;
 
private:
  BackgroundTaskHandle _taskHandle;

  Module* _module;

  bool _restartTask;
 
  friend class Module;
  friend class BackgroundTaskBaseModule;
};
 
 
ML_END_NAMESPACE
 
#endif // __mlBackgroundTaskBaseComponent_H