mlPageRequest.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_H
#define ML_PAGE_REQUEST_H
 
 
#include "mlPagedImage.h"
 
#include <set>
 
ML_START_NAMESPACE
 
class TileRequest;
class PageRequestQueueInterface;
 
//-------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------
class PageRequest
{
public:
  static PageRequest* allocate();
 
  static void deallocate(PageRequest* request);
 
  static void clearFreeList();
 
private:
  PageRequest();
 
  void cleanup();
 
  PageRequest* _freeListNext;
 
  static PageRequest* _freeListHead;
  static Mutex        _freeListMutex;
 
public:
 
  void init(PagedImage* outputImage, MLint pageId, int processingScope);
 
  //------------------------------------------------------
  //------------------------------------------------------
 
  void createInputTileRequests();
 
  void addNeededBy(TileRequest* request) {
    _neededByTiles.push_back(request);
  }
 
  bool tileRequestFinished();
 
  inline bool isNeededByTiles() { return _neededByTiles.size()!=0; }
 
 
  //------------------------------------------------------
  //------------------------------------------------------
 
  bool isReadyForProcessing();
 
  MLErrorCode runCalculateOutputSubImage(UserThreadData* userThreadData);
 
  void copyPageToTileRequests(PageRequestQueueInterface& queue);
 
  PagedImage* getPagedImage() { return _image; }
 
  MLint getPageId() { return _pageId; }
 
  int getProcessingScope() const  { return _processingScope; }
 
 
  //------------------------------------------------------
  //------------------------------------------------------
 
  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; }
 
 
protected:
  void freeInputTiles();
 
  friend class PageRequestCursor;
 
  std::vector <TileRequest*> _inputTiles;
  int                        _inputTilesNeeded;
 
  // TODO: replace with atomic counter of _inputTilesNeeded
  Mutex                      _inputTilesNeededMutex;
 
  int                        _totalInputTilesNeeded;
 
  int                        _traversalCursorPosition;
  int                        _traversalCreatedTiles;
 
  MLMemoryBlockHandle        _page;
  PagedImage*                _image;
  MLint                      _pageId;
 
  MLErrorCode _error;
 
  int _processingScope;
 
  std::vector <TileRequest*> _neededByTiles;
 
  bool _needsToBeRemovedFromPagedImage;
};
 
 
ML_END_NAMESPACE
 
#endif //of __mlPageRequest_H