mlPageRequestCursor.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_PAGE_REQUEST_CURSOR_H
#define ML_PAGE_REQUEST_CURSOR_H

 
// ML-includes
#include "mlInitSystemML.h"
 
#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 &hasCreatedWork);

  bool propagateCancellationDownIfRequestNotNeededAnymore();

  void propagateErrorUpwards(MLErrorCode error);

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

  bool isNeeded();

  void clear();

  TileRequest* currentTileRequest() { return _tileRequest; }

  void append(PageRequest* request) override;

  MLint getNumCreatedPageRequests() const { return _numCreatedPageRequests; };
 
private:
  void commonInit();

  void moveUpToNextDown();

  PageRequest* _pageRequest;
  TileRequest* _tileRequest;

  PageRequest* _pageRequestToPutInQueue;

  int _processingScope;

  int _currentDepth;
 
  MLint _numCreatedPageRequests;
};
 
ML_END_NAMESPACE
 
#endif //of __mlPageRequestCursor_H