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)
	Sets who sends the message. Default is NULL and this means that the message's sender is not a BackgroundTask. More...
BackgroundTask *	sender ()
	Returns the task from which the message originates. More...
void	setReceiver (BackgroundTaskMessageReceiver *receiverArg)
	Sets who receives the message. Default is NULL. More...
BackgroundTaskMessageReceiver *	receiver ()
	Returns the object which receives the message. Default is NULL. More...
virtual void	execute ()=0
	Executes message when it is delivered. More...
virtual void	executeSynchronous ()
	Executes message when it is delivered and the task runs synchronously. More...
virtual bool	finishedProcessing ()
	Returns whether the message needs further processing or if it may be deleted. More...
virtual void	taskWillBeDestroyed ()
	This needs to be implemented if the message uses finishedProcessing() and the task is finished while a message is still on its way. More...

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

Executes message when it is delivered.

Reimplement this in subclasses.

Implemented in ml::BackgroundTaskMethodCallMessage< Object, Method, ArgumentList >, ml::BackgroundTaskMLProcessAllPagesResultMessage, ml::BackgroundTaskMLGetTileResultMessage, ml::BackgroundTaskMLProcessAllPagesMessage, ml::BackgroundTaskMLGetTileMessage, and ml::BackgroundTaskFinishedMessage.

executeSynchronous()

virtual void ml::BackgroundTaskMessage::executeSynchronous ( )

inlinevirtual

Executes message when it is delivered and the task runs synchronously.

The default implementation just calls the execute() method. Reimplement this in subclasses.

Reimplemented in ml::BackgroundTaskMLGetTileBaseMessage.

Definition at line 63 of file mlBackgroundTaskMessage.h.

finishedProcessing()

virtual bool ml::BackgroundTaskMessage::finishedProcessing ( )

inlinevirtual

Returns whether the message needs further processing or if it may be deleted.

If true is returned, the message is placed in another processing queue and finishedProcessing() is called in regular intervals.

Reimplemented in ml::BackgroundTaskMLGetTileBaseMessage.

Definition at line 68 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

Sets who receives the message. Default is NULL.

Definition at line 51 of file mlBackgroundTaskMessage.h.

setSender()

void ml::BackgroundTaskMessage::setSender ( BackgroundTask *  task )

inline

Sets who sends the message. Default is NULL and this means that the message's sender is not a BackgroundTask.

Definition at line 45 of file mlBackgroundTaskMessage.h.

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

Reimplemented in ml::BackgroundTaskMLGetTileBaseMessage.

---

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

• MeVis/Foundation/Sources/MLBackgroundTasks/mlBackgroundTaskMessage.h