#include <mlBackgroundTaskMessage.h>
Public Member Functions | |
| 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 | |
| virtual void | execute ()=0 |
| execute message when it is delivered (reimplement in subclasses) | |
| virtual void | executeSynchronous () |
| execute message when it is delivered and the task runs synchronous, the default implementation just calls the execute() method (reimplement in subclasses). | |
| virtual bool | finishedProcessing () |
| 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 | |
| virtual void | taskWillBeDestroyed () |
| this needs to be implemented if the message uses finishedProcessing() and the task is finished while a message is still on it's way | |
Detailed Description
Definition at line 26 of file mlBackgroundTaskMessage.h.
Constructor & Destructor Documentation
| ml::BackgroundTaskMessage::BackgroundTaskMessage | ( | ) | [inline] |
Definition at line 28 of file mlBackgroundTaskMessage.h.
| virtual ml::BackgroundTaskMessage::~BackgroundTaskMessage | ( | ) | [inline, virtual] |
Definition at line 29 of file mlBackgroundTaskMessage.h.
Member Function Documentation
| virtual void ml::BackgroundTaskMessage::execute | ( | ) | [pure virtual] |
execute message when it is delivered (reimplement in subclasses)
Implemented in ml::BackgroundTaskFinishedMessage, ml::BackgroundTaskMLGetTileMessage, ml::BackgroundTaskMLProcessAllPagesMessage, ml::BackgroundTaskMLGetTileResultMessage, ml::BackgroundTaskMLProcessAllPagesResultMessage, and ml::BackgroundTaskMethodCallMessage< Object, Method, ArgumentList >.
| virtual void ml::BackgroundTaskMessage::executeSynchronous | ( | ) | [inline, virtual] |
execute message when it is delivered and the task runs synchronous, the default implementation just calls the execute() method (reimplement in subclasses).
Reimplemented in ml::BackgroundTaskMLGetTileBaseMessage.
Definition at line 42 of file mlBackgroundTaskMessage.h.
| virtual bool ml::BackgroundTaskMessage::finishedProcessing | ( | ) | [inline, virtual] |
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
Reimplemented in ml::BackgroundTaskMLGetTileBaseMessage.
Definition at line 47 of file mlBackgroundTaskMessage.h.
| BackgroundTask* ml::BackgroundTaskMessage::sender | ( | ) | [inline] |
returns the task from which the message originates
Definition at line 35 of file mlBackgroundTaskMessage.h.
| void ml::BackgroundTaskMessage::setSender | ( | BackgroundTask * | task | ) | [inline] |
set who sends the message (default is NULL and means that the message's sender is not a BackgroundTask)
Definition at line 32 of file mlBackgroundTaskMessage.h.
Referenced by ml::BackgroundTaskFinishedMessage::BackgroundTaskFinishedMessage().
| virtual void ml::BackgroundTaskMessage::taskWillBeDestroyed | ( | ) | [virtual] |
this needs to be implemented if the message uses finishedProcessing() and the task is finished while a message is still on it's way
Reimplemented in ml::BackgroundTaskMLGetTileBaseMessage.
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/MLBackgroundTasks/mlBackgroundTaskMessage.h
