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

Go to the documentation of this file.

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

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

#include "mlPagedImage.h"

ML_START_NAMESPACE

class TileRequest;
class PageRequestQueueInterface;

//-------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------
class PageRequest
{
public:
  PageRequest(PagedImage* outputImage, MLint pageId);

  ~PageRequest();

  //------------------------------------------------------

  //------------------------------------------------------

  void createInputTileRequests();

  void addNeededBy(TileRequest* request) {
    _neededByTiles.push_back(request);
  }

  bool tileRequestFinished() { _inputTilesNeeded--; return _inputTilesNeeded==0; }

  inline bool isNeededByTiles() { return _neededByTiles.size()!=0; }


  //------------------------------------------------------

  //------------------------------------------------------

  inline bool isReadyForProcessing() { return _inputTilesNeeded == 0; };

  MLErrorCode runCalculateOutputSubImage();

  void copyPageToTileRequests(PageRequestQueueInterface& queue);


  //------------------------------------------------------

  //------------------------------------------------------

  void propagateErrorUpwards(MLErrorCode error);

  bool propagateCancellationDownIfRequestNotNeededAnymore();

  void collectPageRequestsWithErrors(std::set<PageRequest*>& result);

  bool hasError() const { return _error!=ML_RESULT_OK; }

  void setError(MLErrorCode error) { _error = error; }

  MLErrorCode getError() { return _error; }


#ifdef ML_TILEREQUEST_DEBUG_PRINTING
  // TODO: remove or replace with stream ops
  void print(int depth);
#endif

protected:
  void freeInputTiles();

  friend class PageRequestCursor;

  std::vector <TileRequest*> _inputTiles;
  int                        _inputTilesNeeded;
  int                        _totalInputTilesNeeded;

  int                        _traversalCursorPosition;
  int                        _traversalCreatedTiles;

  MLMemoryBlockHandle        _page;
  PagedImage*                  _image;
  MLint                      _pageId;

  MLErrorCode _error;

  std::vector <TileRequest*> _neededByTiles;
};


ML_END_NAMESPACE

#endif //of __mlPageRequest_H