ml::BackgroundTaskMessage Class Reference

The base class of all background messages. More...

#include <mlBackgroundTaskMessage.h>

Inheritance diagram for ml::BackgroundTaskMessage:

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
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	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

The base class of all background messages.

Definition at line 39 of file mlBackgroundTaskMessage.h.

Constructor & Destructor Documentation

BackgroundTaskMessage()

ml::BackgroundTaskMessage::BackgroundTaskMessage

(

)

~BackgroundTaskMessage()

virtual ml::BackgroundTaskMessage::~BackgroundTaskMessage ( )

inlinevirtual

Definition at line 42 of file mlBackgroundTaskMessage.h.

Member Function Documentation

execute()

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 >.

executeSynchronous()

virtual void ml::BackgroundTaskMessage::executeSynchronous ( )

inlinevirtual

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 61 of file mlBackgroundTaskMessage.h.

finishedProcessing()

virtual bool ml::BackgroundTaskMessage::finishedProcessing ( )

inlinevirtual

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 66 of file mlBackgroundTaskMessage.h.

receiver()

BackgroundTaskMessageReceiver * ml::BackgroundTaskMessage::receiver ( )

inline

returns the object which receives the message (default is NULL)

Definition at line 54 of file mlBackgroundTaskMessage.h.

sender()

BackgroundTask * ml::BackgroundTaskMessage::sender ( )

inline

returns the task from which the message originates

Definition at line 48 of file mlBackgroundTaskMessage.h.

setReceiver()

void ml::BackgroundTaskMessage::setReceiver ( BackgroundTaskMessageReceiver * receiverArg )

inline

set who receives the message (default is NULL)

Definition at line 51 of file mlBackgroundTaskMessage.h.

References mlrange_cast().

setSender()

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 45 of file mlBackgroundTaskMessage.h.

References mlrange_cast().

Referenced by ml::BackgroundTaskFinishedMessage::BackgroundTaskFinishedMessage().

taskWillBeDestroyed()

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