mlGetTileJob.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_GET_TILE_JOB_H
#define ML_GET_TILE_JOB_H

 
// ML-includes
#include "mlInitSystemML.h"
 
#include "mlPagedImage.h"
#include "mlTileRequest.h"
#include "mlPageRequestCursor.h"
 
ML_START_NAMESPACE
 
class PageRequest;
class PageRequestProcessor;

class MLEXPORT GetTileJobBase
{
public:
  GetTileJobBase();
 
  virtual ~GetTileJobBase();

  virtual MLErrorCode init(PageRequestProcessor& processor) = 0;

  double getProgress() const;

  bool hasFinished() { return _request->hasFinished(); }

  bool hasError() const { return _request->hasError(); }

  MLErrorCode getError() const { return _request->getError(); }

  void setTileRequestFinishedCB(TileRequestFinishedCB* cb, void* data) { _request->setTileRequestFinishedCB(cb, data); }

  void cancel();

  void updateProgress();

  virtual void delegateProgressUpdate(double /*progress*/) {};

  void setProgressCB(MLRequestProgressCB* progressCallback, void* progressCallbackUserData);
 
protected:
  TileRequest*         _request;
  MLRequestProgressCB* _progressCB;
  void* _progressCBUserData;
  double _lastProgress;
};
 
//-------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------
class MLEXPORT GetTileJob : public GetTileJobBase
{
public:
  GetTileJob(PagedImage& image, const SubImageBox& box, MLDataType datatype,
    const ScaleShiftData& scaleShiftData = ScaleShiftData());

  ~GetTileJob() override;

  MLErrorCode init(PageRequestProcessor& processor) override;

  void setAllocationPolicy(TileRequest::AllocationPolicy policy) { _request->setAllocationPolicy(policy); }

  void setRequestAsReadOnlyPage() { _request->setUseTileReadOnly(true); setAllocationPolicy(TileRequest::NoAllocation); }

  void setExternalDataBuffer(void* data) {
    _request->setAllocationPolicy(TileRequest::ExternalBuffer);
    _request->setExternalDataBuffer(data);
  }

  const SubImage& getSubImage() {
    return _request->getSubImage();
  }
 
};
 
ML_END_NAMESPACE
 
#endif //of __mlGetTileJob_H