mlBackgroundTaskMessages.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_MESSAGES_H
#define ML_BACKGROUND_TASK_MESSAGES_H
 
// Local includes
#include "MLBackgroundTasksSystem.h"
#include "mlBackgroundTaskMessage.h"
#include "mlImagingBackgroundTask.h"
#include "mlBackgroundTaskMethodCallMessage.h"
 
ML_START_NAMESPACE
 
class GetTileJobBase;
class ProcessAllPagesHandler;
 
class MLBACKGROUNDTASKS_EXPORT BackgroundTaskFinishedMessage : public BackgroundTaskMessage {
public:
  BackgroundTaskFinishedMessage(BackgroundTask* task):BackgroundTaskMessage() { setSender(task); }
 
  void execute() override;
 
};
 
//--------------------------------------------------------------------------------------
class MLBACKGROUNDTASKS_EXPORT BackgroundTaskMLGetTileBaseMessage : public BackgroundTaskMessage {
public:
  BackgroundTaskMLGetTileBaseMessage(BackgroundRequestId tileId, Module* module)
    : BackgroundTaskMessage(), _request(nullptr), _module(module), _tileId(tileId), _resultWasSent(false) {
  }
 
  ~BackgroundTaskMLGetTileBaseMessage() override;
 
  void executeSynchronous() override;
 
  bool finishedProcessing() override;
 
  void taskWillBeDestroyed() override;
 
  static  void tileRequestFinishedCB(void* data, TileRequest* request);
 
  virtual void sendFinishedRequest() = 0;
 
  virtual void sendFailedRequest() = 0;
 
  virtual void sendProgress() = 0;
 
protected:
  GetTileJobBase*      _request;
  Module*              _module;
  BackgroundRequestId  _tileId;
  bool                 _resultWasSent;
};
 
//--------------------------------------------------------------------------------------
 
class MLBACKGROUNDTASKS_EXPORT BackgroundTaskMLGetTileMessage : public BackgroundTaskMLGetTileBaseMessage {
public:
  BackgroundTaskMLGetTileMessage(BackgroundRequestId tileId, Module* module,
    int inputImageIndex, MLDataType type, const SubImageBox& box, const ScaleShiftData& shift = ScaleShiftData(),
    int getTileFlags = 0, ManagedSubImage* externalBuffer = nullptr);
 
  ~BackgroundTaskMLGetTileMessage() override;
 
  void execute() override;
 
  void sendFinishedRequest() override;
 
  void sendFailedRequest() override;
 
  void sendProgress() override;
 
private:
  ManagedSubImage* _externalBuffer;
  int              _inputImageIndex;
  MLDataType       _type;
  SubImageBox      _box;
  ScaleShiftData   _shift;
  int              _getTileFlags;
};
 
//--------------------------------------------------------------------------------------
 
class MLBACKGROUNDTASKS_EXPORT BackgroundTaskMLProcessAllPagesMessage : public BackgroundTaskMLGetTileBaseMessage {
public:
  BackgroundTaskMLProcessAllPagesMessage(BackgroundRequestId tileId, Module* module, ProcessAllPagesHandler* handler, const SubImageBox& box);
 
  ~BackgroundTaskMLProcessAllPagesMessage() override;
 
  void execute() override;
 
  void sendFinishedRequest() override;
 
  void sendFailedRequest() override;
 
  void sendProgress() override;
 
private:
  ProcessAllPagesHandler* _handler;
  SubImageBox             _box;
  bool                    _ownsHandler;
};
 
//--------------------------------------------------------------------------------------
 
class MLBACKGROUNDTASKS_EXPORT BackgroundTaskMLGetTileResultMessage : public BackgroundTaskMessage {
public:
  BackgroundTaskMLGetTileResultMessage(ImagingBackgroundTask* task, BackgroundRequestId tileId, ManagedSubImage* img):BackgroundTaskMessage() {
    _task = task;
    _image = img;
    _tileId = tileId;
  }
  ~BackgroundTaskMLGetTileResultMessage() override;
 
  void execute() override;
 
private:
  BackgroundRequestId    _tileId;
  ManagedSubImage*       _image;
  ImagingBackgroundTask* _task;
};
 
 
//--------------------------------------------------------------------------------------
 
class MLBACKGROUNDTASKS_EXPORT BackgroundTaskMLProcessAllPagesResultMessage : public BackgroundTaskMessage {
public:
  BackgroundTaskMLProcessAllPagesResultMessage(ImagingBackgroundTask* task, BackgroundRequestId requestId, ProcessAllPagesHandler* handler):BackgroundTaskMessage() {
    _task = task;
    _handler = handler;
    _requestId = requestId;
  }
  ~BackgroundTaskMLProcessAllPagesResultMessage() override;
 
  void execute() override;
 
private:
  BackgroundRequestId    _requestId;
  ProcessAllPagesHandler* _handler;
  ImagingBackgroundTask* _task;
};
 
ML_END_NAMESPACE
 
#endif