MeVisLab Toolbox Reference
Public Member Functions | List of all members
ml::BackgroundTaskMLProcessAllPagesResultMessage Class Reference

#include <mlBackgroundTaskMessages.h>

Inheritance diagram for ml::BackgroundTaskMLProcessAllPagesResultMessage:
ml::BackgroundTaskMessage

Public Member Functions

 BackgroundTaskMLProcessAllPagesResultMessage (ImagingBackgroundTask *task, BackgroundRequestId requestId, ProcessAllPagesHandler *handler)
 
 ~BackgroundTaskMLProcessAllPagesResultMessage () override
 
void execute () override
 execute message when it is delivered (reimplement in subclasses)
 
- 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)
 
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 136 of file mlBackgroundTaskMessages.h.

Constructor & Destructor Documentation

◆ BackgroundTaskMLProcessAllPagesResultMessage()

ml::BackgroundTaskMLProcessAllPagesResultMessage::BackgroundTaskMLProcessAllPagesResultMessage ( ImagingBackgroundTask * task,
BackgroundRequestId requestId,
ProcessAllPagesHandler * handler )
inline

Definition at line 138 of file mlBackgroundTaskMessages.h.

References mlrange_cast().

◆ ~BackgroundTaskMLProcessAllPagesResultMessage()

ml::BackgroundTaskMLProcessAllPagesResultMessage::~BackgroundTaskMLProcessAllPagesResultMessage ( )
override

Member Function Documentation

◆ execute()

void ml::BackgroundTaskMLProcessAllPagesResultMessage::execute ( )
overridevirtual

execute message when it is delivered (reimplement in subclasses)

Implements ml::BackgroundTaskMessage.

The documentation for this class was generated from the following file: