ml::BackgroundTaskMLGetTileBaseMessage Class Reference

#include <mlBackgroundTaskMessages.h>

Inheritance diagram for ml::BackgroundTaskMLGetTileBaseMessage:

Public Member Functions
	BackgroundTaskMLGetTileBaseMessage (BackgroundRequestId tileId, Module *module)
	~BackgroundTaskMLGetTileBaseMessage () override
void	executeSynchronous () override
	Executes message when it is delivered and the task runs synchronously.
bool	finishedProcessing () override
	Returns whether the message needs further processing or if it may be deleted.
void	taskWillBeDestroyed () override
	This needs to be implemented if the message uses finishedProcessing() and the task is finished while a message is still on its way.
virtual void	sendFinishedRequest ()=0
virtual void	sendFailedRequest ()=0
virtual void	sendProgress ()=0
Public Member Functions inherited from ml::BackgroundTaskMessage
	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.
BackgroundTask *	sender ()
	Returns the task from which the message originates.
void	setReceiver (BackgroundTaskMessageReceiver *receiverArg)
	Sets who receives the message. Default is NULL.
BackgroundTaskMessageReceiver *	receiver ()
	Returns the object which receives the message. Default is NULL.
virtual void	execute ()=0
	Executes message when it is delivered.

Static Public Member Functions
static void	tileRequestFinishedCB (void *data, TileRequest *request)

Protected Attributes
GetTileJobBase *	_request
Module *	_module
BackgroundRequestId	_tileId
bool	_resultWasSent

Detailed Description

Definition at line 36 of file mlBackgroundTaskMessages.h.

Constructor & Destructor Documentation

BackgroundTaskMLGetTileBaseMessage()

ml::BackgroundTaskMLGetTileBaseMessage::BackgroundTaskMLGetTileBaseMessage ( BackgroundRequestId tileId, Module * module )

inline

Definition at line 38 of file mlBackgroundTaskMessages.h.

~BackgroundTaskMLGetTileBaseMessage()

ml::BackgroundTaskMLGetTileBaseMessage::~BackgroundTaskMLGetTileBaseMessage ( )

override

Member Function Documentation

executeSynchronous()

void ml::BackgroundTaskMLGetTileBaseMessage::executeSynchronous ( )

overridevirtual

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

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

Reimplemented from ml::BackgroundTaskMessage.

finishedProcessing()

bool ml::BackgroundTaskMLGetTileBaseMessage::finishedProcessing ( )

overridevirtual

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 from ml::BackgroundTaskMessage.

sendFailedRequest()

virtual void ml::BackgroundTaskMLGetTileBaseMessage::sendFailedRequest ( )

pure virtual

Implemented in ml::BackgroundTaskMLGetTileMessage, and ml::BackgroundTaskMLProcessAllPagesMessage.

sendFinishedRequest()

virtual void ml::BackgroundTaskMLGetTileBaseMessage::sendFinishedRequest ( )

pure virtual

Implemented in ml::BackgroundTaskMLGetTileMessage, and ml::BackgroundTaskMLProcessAllPagesMessage.

sendProgress()

virtual void ml::BackgroundTaskMLGetTileBaseMessage::sendProgress ( )

pure virtual

Implemented in ml::BackgroundTaskMLGetTileMessage, and ml::BackgroundTaskMLProcessAllPagesMessage.

taskWillBeDestroyed()

void ml::BackgroundTaskMLGetTileBaseMessage::taskWillBeDestroyed ( )

overridevirtual

This needs to be implemented if the message uses finishedProcessing() and the task is finished while a message is still on its way.

Reimplemented from ml::BackgroundTaskMessage.

tileRequestFinishedCB()

static void ml::BackgroundTaskMLGetTileBaseMessage::tileRequestFinishedCB ( void * data, TileRequest * request )

static

Member Data Documentation

_module

Module* ml::BackgroundTaskMLGetTileBaseMessage::_module

protected

Definition at line 60 of file mlBackgroundTaskMessages.h.

_request

GetTileJobBase* ml::BackgroundTaskMLGetTileBaseMessage::_request

protected

Definition at line 59 of file mlBackgroundTaskMessages.h.

_resultWasSent

bool ml::BackgroundTaskMLGetTileBaseMessage::_resultWasSent

protected

Definition at line 62 of file mlBackgroundTaskMessages.h.

_tileId

BackgroundRequestId ml::BackgroundTaskMLGetTileBaseMessage::_tileId

protected

Definition at line 61 of file mlBackgroundTaskMessages.h.

---

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

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