MeVis/Foundation/Sources/ML/include/host/mlGetTileJob.h

Go to the documentation of this file.

// **InsertLicense** code
//-------------------------------------------------------------------------
//-------------------------------------------------------------------------
#ifndef __mlGetTileJob_H
#define __mlGetTileJob_H

// ML-includes
#ifndef __mlInitSystemML_H
#include "mlInitSystemML.h"
#endif

#include "mlPagedImage.h"
#include "mlTileRequest.h"
#include "mlPageRequestCursor.h"

ML_START_NAMESPACE

class PageRequest;
class PageRequestProcessor;

class MLEXPORT GetTileJobBase
{
public:
  GetTileJobBase() { _request = NULL; }

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

  bool isCursorNeeded() { return _cursor.isNeeded(); }

protected:
  TileRequest*         _request;
  PageRequestCursor    _cursor;
};

//-------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------
class MLEXPORT GetTileJob : public GetTileJobBase
{
public:
  GetTileJob(PagedImage& image, const SubImageBox& box, MLDataType datatype,
    const ScaleShiftData& scaleShiftData = ScaleShiftData()):_localRequest(&image, box, datatype, scaleShiftData)
  {
    _request = &_localRequest;
    _cursor.init(&_localRequest);
  }

  ~GetTileJob();

  virtual MLErrorCode init(PageRequestProcessor& processor);

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


private:
  TileRequest          _localRequest;
};

ML_END_NAMESPACE

#endif //of __mlGetTileJob_H