ml::ProcessAllPagesBackgroundTask Class Reference

Class ProcessAllPagesBackgroundTask. More...

#include <mlProcessAllPagesBackgroundTask.h>

Inheritance diagram for ml::ProcessAllPagesBackgroundTask:

List of all members.

Public Member Functions
	ProcessAllPagesBackgroundTask (Module *module, FloatField *progressField=NULL, StringField *statusField=NULL)
	~ProcessAllPagesBackgroundTask ()
void	setHandler (ProcessAllPagesHandler *handler)
	Set the pointer to a ProcessAllPagesHandler, ownership is passed to the ProcessAllPagesBackgroundTask.
ProcessAllPagesHandler *	getHandler () const
	Get access to the handler (the ownership stays with ProcessAllPagesBackgroundTask).
void	setRegion (const SubImageBox &box)
	Set the box to be processed (default is the full image).
SubImageBox	getRegion () const
	Get the box to be processed.
void	setInitialStatusMessage (const std::string &status)
	Set the initial status string that should be displayed.
virtual void	run ()
	reimp

---

Detailed Description

Class ProcessAllPagesBackgroundTask.

A simple background task that takes a ProcessAllPagesHandler and a box and runs the processing in the background using its run() method. If no ProcessAllPagesHandler is given (or set to NULL), a processAllPages(-1) is started on the Module.

Definition at line 27 of file mlProcessAllPagesBackgroundTask.h.

---

Constructor & Destructor Documentation

ml::ProcessAllPagesBackgroundTask::ProcessAllPagesBackgroundTask	(	Module *	module,
		FloatField *	progressField = NULL,
		StringField *	statusField = NULL
	)

ml::ProcessAllPagesBackgroundTask::~ProcessAllPagesBackgroundTask

(

)

---

Member Function Documentation

ProcessAllPagesHandler* ml::ProcessAllPagesBackgroundTask::getHandler

(

)

const [inline]

Get access to the handler (the ownership stays with ProcessAllPagesBackgroundTask).

Definition at line 37 of file mlProcessAllPagesBackgroundTask.h.

SubImageBox ml::ProcessAllPagesBackgroundTask::getRegion

(

)

const [inline]

Get the box to be processed.

Definition at line 43 of file mlProcessAllPagesBackgroundTask.h.

virtual void ml::ProcessAllPagesBackgroundTask::run

(

)

[virtual]

reimp

Implements ml::BackgroundTask.

void ml::ProcessAllPagesBackgroundTask::setHandler

(

ProcessAllPagesHandler *

handler

)

[inline]

Set the pointer to a ProcessAllPagesHandler, ownership is passed to the ProcessAllPagesBackgroundTask.

Definition at line 35 of file mlProcessAllPagesBackgroundTask.h.

void ml::ProcessAllPagesBackgroundTask::setInitialStatusMessage

(

const std::string &

status

)

[inline]

Set the initial status string that should be displayed.

Definition at line 46 of file mlProcessAllPagesBackgroundTask.h.

void ml::ProcessAllPagesBackgroundTask::setRegion

(

const SubImageBox &

box

)

[inline]

Set the box to be processed (default is the full image).

Definition at line 40 of file mlProcessAllPagesBackgroundTask.h.

---

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

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