MeVis/Foundation/Sources/MLBackgroundTasks/mlBackgroundTaskMessages.h

Go to the documentation of this file.

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


#ifndef __mlBackgroundTaskMessages_H
#define __mlBackgroundTaskMessages_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); }

  virtual void execute();

};

//--------------------------------------------------------------------------------------
class MLBACKGROUNDTASKS_EXPORT BackgroundTaskMLGetTileBaseMessage : public BackgroundTaskMessage {
public:
  BackgroundTaskMLGetTileBaseMessage(BackgroundRequestId tileId, Module* module)
    : BackgroundTaskMessage(), _request(NULL), _module(module), _tileId(tileId), _resultWasSent(false) {
  }

  ~BackgroundTaskMLGetTileBaseMessage();

  virtual void executeSynchronous();

  virtual bool finishedProcessing();

  virtual void taskWillBeDestroyed();

  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 = NULL);

  ~BackgroundTaskMLGetTileMessage();

  virtual void execute();

  virtual void sendFinishedRequest();

  virtual void sendFailedRequest();

  virtual void sendProgress();

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();

  virtual void execute();

  virtual void sendFinishedRequest();

  virtual void sendFailedRequest();

  virtual void sendProgress();

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();

  virtual void execute();

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();

  virtual void execute();

private:
  BackgroundRequestId    _requestId;
  ProcessAllPagesHandler* _handler;
  ImagingBackgroundTask* _task;
};

ML_END_NAMESPACE

#endif