Base class for TileRequest based jobs. More...
#include <mlGetTileJob.h>
Public Member Functions | |
| GetTileJobBase () | |
| virtual | ~GetTileJobBase () |
| virtual MLErrorCode | init (PageRequestProcessor &processor)=0 |
| Initializes the tile request and add it to the processor if no error occurs. | |
| double | getProgress () const |
| Returns the current progress of the tile request ([0..1] range). | |
| bool | hasFinished () |
Returns if the request has finished (If an error happened, true will be returned as well). | |
| bool | hasError () const |
| Returns if the request has an error (and the data is thus unusable/invalid). | |
| MLErrorCode | getError () const |
| Returns the error that happened (return ML_RESULT_OK if everything is ok). | |
| void | setTileRequestFinishedCB (TileRequestFinishedCB *cb, void *data) |
| Sets the tile request finished cb, which is called when the tile is ready. | |
| void | cancel () |
| Cancels the GetTileJob, this only sets the flag, the real cancellation needs to be done on the PageRequestProcessor. | |
| bool | isCursorNeeded () |
| Returns if the cursor is still needed, which can even happen if the request itself has been canceled. | |
Protected Attributes | |
| TileRequest * | _request |
| The root TileRequest that is used internally. | |
| PageRequestCursor | _cursor |
| The cursor that is used to create the PageRequest/TileRequests that are needed to fullfil the _request. | |
Detailed Description
Base class for TileRequest based jobs.
Definition at line 28 of file mlGetTileJob.h.
Constructor & Destructor Documentation
| ml::GetTileJobBase::GetTileJobBase | ( | ) | [inline] |
Definition at line 31 of file mlGetTileJob.h.
| virtual ml::GetTileJobBase::~GetTileJobBase | ( | ) | [virtual] |
Member Function Documentation
| void ml::GetTileJobBase::cancel | ( | ) |
Cancels the GetTileJob, this only sets the flag, the real cancellation needs to be done on the PageRequestProcessor.
| MLErrorCode ml::GetTileJobBase::getError | ( | ) | const [inline] |
Returns the error that happened (return ML_RESULT_OK if everything is ok).
Definition at line 48 of file mlGetTileJob.h.
| double ml::GetTileJobBase::getProgress | ( | ) | const |
Returns the current progress of the tile request ([0..1] range).
| bool ml::GetTileJobBase::hasError | ( | ) | const [inline] |
Returns if the request has an error (and the data is thus unusable/invalid).
Definition at line 45 of file mlGetTileJob.h.
| bool ml::GetTileJobBase::hasFinished | ( | ) | [inline] |
Returns if the request has finished (If an error happened, true will be returned as well).
Definition at line 42 of file mlGetTileJob.h.
| virtual MLErrorCode ml::GetTileJobBase::init | ( | PageRequestProcessor & | processor | ) | [pure virtual] |
Initializes the tile request and add it to the processor if no error occurs.
Implemented in ml::GetTileJob, and ml::ProcessAllPagesJob.
| bool ml::GetTileJobBase::isCursorNeeded | ( | ) | [inline] |
Returns if the cursor is still needed, which can even happen if the request itself has been canceled.
Definition at line 57 of file mlGetTileJob.h.
| void ml::GetTileJobBase::setTileRequestFinishedCB | ( | TileRequestFinishedCB * | cb, |
| void * | data | ||
| ) | [inline] |
Sets the tile request finished cb, which is called when the tile is ready.
Definition at line 51 of file mlGetTileJob.h.
Member Data Documentation
PageRequestCursor ml::GetTileJobBase::_cursor [protected] |
The cursor that is used to create the PageRequest/TileRequests that are needed to fullfil the _request.
Definition at line 63 of file mlGetTileJob.h.
TileRequest* ml::GetTileJobBase::_request [protected] |
The root TileRequest that is used internally.
Definition at line 61 of file mlGetTileJob.h.
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/ML/include/host/mlGetTileJob.h
