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 |
| execute message when it is delivered (reimplement in subclasses) | |
| 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 |
| execute message when it is delivered and the task runs synchronous, the default implementation just calls the execute() method (reimplement in subclasses). | |
| bool | finishedProcessing () override |
| tells if the message needs further processing or if it may be deleted if true is returned, the message is placed to another processing queue and finishedProcessing() is called in regular intervals | |
| void | taskWillBeDestroyed () override |
| this needs to be implemented if the message uses finishedProcessing() and the task is finished while a message is still on it's way | |
| Public Member Functions inherited from ml::BackgroundTaskMessage | |
| BackgroundTaskMessage () | |
| virtual | ~BackgroundTaskMessage () |
| void | setSender (BackgroundTask *task) |
| set who sends the message (default is NULL and means that the message's sender is not a BackgroundTask) | |
| BackgroundTask * | sender () |
| returns the task from which the message originates | |
| void | setReceiver (BackgroundTaskMessageReceiver *receiverArg) |
| set 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 |
execute message when it is delivered (reimplement 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
