A cursor to create page and tile requests iteratively, allowing breaks and resumption at any time, and avoiding a recursive tree traversal that is difficult to resume. More...
#include <mlPageRequestCursor.h>
Public Types | |
| enum | CursorState { HasMoreWork , HasFinished , IsBlocked } |
| Defines the current state of the cursor. More... | |
Public Member Functions | |
| PageRequestCursor (PageRequest *request) | |
| Creates a cursor from a root PageRequest. | |
| PageRequestCursor (TileRequest *request) | |
| Creates a cursor from a root TileRequest. | |
| PageRequestCursor () | |
| Creates an empty cursor. | |
| void | init (TileRequest *request) |
| Initializes from a TileRequest. | |
| void | setProcessingScope (int scope) |
| Sets the processing scope. | |
| int | getProcessingScope () const |
| Returns the processing scope. | |
| CursorState | nextStep (PageRequestQueueInterface &queue, bool &hasCreatedWork) |
| Implements an iterative tree traversal with automatic expanding of the tile and page requests. | |
| bool | propagateCancellationDownIfRequestNotNeededAnymore () |
| See Page/TileRequest. | |
| void | propagateErrorUpwards (MLErrorCode error) |
| See Page/TileRequest. | |
| void | collectPageRequestsWithErrors (std::set< PageRequest * > &result) |
| See Page/TileRequest. | |
| bool | isNeeded () |
| Returns whether the cursor is still needed (which is the case when it points to either a PageRequest or TileRequest). | |
| void | clear () |
| Clears the cursor so that it points to no requests anymore. | |
| TileRequest * | currentTileRequest () |
| Returns the current tile request. | |
| void | append (PageRequest *request) override |
Appends PageRequest request that is ready for processing to the work queue. | |
| MLint | getNumCreatedPageRequests () const |
| Returns number of created page requests (inner requests, not the requests that are in the queue). | |
 Public Member Functions inherited from ml::PageRequestQueueInterface | |
| virtual | ~PageRequestQueueInterface () |
| Virtual destructor to get rid of warning. | |
Detailed Description
A cursor to create page and tile requests iteratively, allowing breaks and resumption at any time, and avoiding a recursive tree traversal that is difficult to resume.
Definition at line 37 of file mlPageRequestCursor.h.
Member Enumeration Documentation
◆ CursorState
Defines the current state of the cursor.
| Enumerator | |
|---|---|
| HasMoreWork | Further work is available, re-call nextStep(). |
| HasFinished | The cursor has no more work and may be removed. |
| IsBlocked | The cursor has more work but is blocked by a pending request (e.g., a pending memory image). |
Definition at line 57 of file mlPageRequestCursor.h.
Constructor & Destructor Documentation
◆ PageRequestCursor() [1/3]
| ml::PageRequestCursor::PageRequestCursor | ( | PageRequest * | request | ) |
Creates a cursor from a root PageRequest.
◆ PageRequestCursor() [2/3]
| ml::PageRequestCursor::PageRequestCursor | ( | TileRequest * | request | ) |
Creates a cursor from a root TileRequest.
◆ PageRequestCursor() [3/3]
| ml::PageRequestCursor::PageRequestCursor | ( | ) |
Creates an empty cursor.
Member Function Documentation
◆ append()
|
overridevirtual |
Appends PageRequest request that is ready for processing to the work queue.
Implements ml::PageRequestQueueInterface.
◆ clear()
| void ml::PageRequestCursor::clear | ( | ) |
Clears the cursor so that it points to no requests anymore.
◆ collectPageRequestsWithErrors()
| void ml::PageRequestCursor::collectPageRequestsWithErrors | ( | std::set< PageRequest * > & | result | ) |
See Page/TileRequest.
◆ currentTileRequest()
|
inline |
Returns the current tile request.
Definition at line 85 of file mlPageRequestCursor.h.
◆ getNumCreatedPageRequests()
|
inline |
Returns number of created page requests (inner requests, not the requests that are in the queue).
Definition at line 91 of file mlPageRequestCursor.h.
◆ getProcessingScope()
|
inline |
Returns the processing scope.
Definition at line 54 of file mlPageRequestCursor.h.
◆ init()
| void ml::PageRequestCursor::init | ( | TileRequest * | request | ) |
Initializes from a TileRequest.
◆ isNeeded()
| bool ml::PageRequestCursor::isNeeded | ( | ) |
Returns whether the cursor is still needed (which is the case when it points to either a PageRequest or TileRequest).
◆ nextStep()
| CursorState ml::PageRequestCursor::nextStep | ( | PageRequestQueueInterface & | queue, |
| bool & | hasCreatedWork ) |
Implements an iterative tree traversal with automatic expanding of the tile and page requests.
Page requests that are ready for processing are added to the queue. The return value indicates whether there is more work available from this cursor, whether it has finished, or whether it is blocked (which can happen on MemoryImage calculations).
◆ propagateCancellationDownIfRequestNotNeededAnymore()
| bool ml::PageRequestCursor::propagateCancellationDownIfRequestNotNeededAnymore | ( | ) |
See Page/TileRequest.
◆ propagateErrorUpwards()
| void ml::PageRequestCursor::propagateErrorUpwards | ( | MLErrorCode | error | ) |
See Page/TileRequest.
◆ setProcessingScope()
|
inline |
Sets the processing scope.
Definition at line 51 of file mlPageRequestCursor.h.
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/ML/include/host/mlPageRequestCursor.h
