ml::BackgroundTaskMLProcessAllPagesMessage Class Reference
#include <mlBackgroundTaskMessages.h>
Inheritance diagram for ml::BackgroundTaskMLProcessAllPagesMessage:
Public Member Functions | |
| BackgroundTaskMLProcessAllPagesMessage (BackgroundRequestId tileId, Module *module, ProcessAllPagesHandler *handler, const SubImageBox &box) | |
| ~BackgroundTaskMLProcessAllPagesMessage () override | |
| void | execute () override |
| Executes message when it is delivered. | |
| void | sendFinishedRequest () override |
| void | sendFailedRequest () override |
| void | sendProgress () override |
 Public Member Functions inherited from ml::BackgroundTaskMLGetTileBaseMessage | |
| BackgroundTaskMLGetTileBaseMessage (BackgroundRequestId tileId, Module *module) | |
| ~BackgroundTaskMLGetTileBaseMessage () override | |
| void | executeSynchronous () override |
| Executes message when it is delivered and the task runs synchronously. | |
| bool | finishedProcessing () override |
| Returns whether the message needs further processing or if it may be deleted. | |
| void | taskWillBeDestroyed () override |
| This needs to be implemented if the message uses finishedProcessing() and the task is finished while a message is still on its way. | |
| Public Member Functions inherited from ml::BackgroundTaskMessage | |
| BackgroundTaskMessage () | |
| virtual | ~BackgroundTaskMessage () |
| void | setSender (BackgroundTask *task) |
| Sets who sends the message. Default is NULL and this means that the message's sender is not a BackgroundTask. | |
| BackgroundTask * | sender () |
| Returns the task from which the message originates. | |
| void | setReceiver (BackgroundTaskMessageReceiver *receiverArg) |
| Sets who receives the message. Default is NULL. | |
| BackgroundTaskMessageReceiver * | receiver () |
| Returns the object which receives the message. Default is NULL. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ml::BackgroundTaskMLGetTileBaseMessage | |
| static void | tileRequestFinishedCB (void *data, TileRequest *request) |
| Protected Attributes inherited from ml::BackgroundTaskMLGetTileBaseMessage | |
| GetTileJobBase * | _request |
| Module * | _module |
| BackgroundRequestId | _tileId |
| bool | _resultWasSent |
Detailed Description
Definition at line 94 of file mlBackgroundTaskMessages.h.
Constructor & Destructor Documentation
◆ BackgroundTaskMLProcessAllPagesMessage()
| ml::BackgroundTaskMLProcessAllPagesMessage::BackgroundTaskMLProcessAllPagesMessage | ( | BackgroundRequestId | tileId, |
| Module * | module, | ||
| ProcessAllPagesHandler * | handler, | ||
| const SubImageBox & | box | ||
| ) |
◆ ~BackgroundTaskMLProcessAllPagesMessage()
|
override |
Member Function Documentation
◆ execute()
|
overridevirtual |
Executes message when it is delivered.
Reimplement this in subclasses.
Implements ml::BackgroundTaskMessage.
◆ sendFailedRequest()
|
overridevirtual |
Implements ml::BackgroundTaskMLGetTileBaseMessage.
◆ sendFinishedRequest()
|
overridevirtual |
Implements ml::BackgroundTaskMLGetTileBaseMessage.
◆ sendProgress()
|
overridevirtual |
Implements ml::BackgroundTaskMLGetTileBaseMessage.
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/MLBackgroundTasks/mlBackgroundTaskMessages.h
