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

Go to the documentation of this file.

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

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

#include <host/mlPageRequestProcessor.h>

#include <set>

ML_START_NAMESPACE

class TileRequest;
class PageRequest;

#define ML_PAGEREQUEST_TILES_NOT_CREATED -1
#define ML_TILEREQUEST_PAGES_NOT_CREATED -1

//-------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------
class MLEXPORT PageRequestCursor : public PageRequestQueueInterface
{
public:
  PageRequestCursor(PageRequest* request);
  PageRequestCursor(TileRequest* request);
  PageRequestCursor();

  void init(TileRequest* request);

  void setProcessingScope(int scope) { _processingScope = scope; }

  int getProcessingScope() const { return _processingScope; }

  enum CursorState {
    HasMoreWork, 
    HasFinished, 
    IsBlocked    
  };

  CursorState nextStep(PageRequestQueueInterface& queue);

  bool propagateCancellationDownIfRequestNotNeededAnymore();

  void propagateErrorUpwards(MLErrorCode error);

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

  bool isNeeded();

  void clear();

  TileRequest* currentTileRequest() { return _tileRequest; }

  virtual void append(PageRequest* request);

private:
  void commonInit();

  void moveUpToNextDown();

  PageRequest* _pageRequest;
  TileRequest* _tileRequest;

  PageRequest* _pageRequestToPutInQueue;

  int _processingScope;

  int _currentDepth;
};

ML_END_NAMESPACE

#endif //of __mlPageRequestCursor_H