ml::BackgroundTaskStatusInformation Class Reference

BackgroundTaskStatusInformation creates a snapshot of the status of a given BackgroundTask, to allow later read access without races or even destruction of the background task (copyable). More...

#include <mlBackgroundTaskStatusInformation.h>

List of all members.

Public Member Functions
	BackgroundTaskStatusInformation ()
	BackgroundTaskStatusInformation (BackgroundTask *task)
std::string	statusString () const
float	progress () const
BackgroundTask::Status	status () const
void *	owner () const
MLuint32	taskId () const
Protected Attributes
std::string	_statusString
float	_progress
BackgroundTask::Status	_status
void *	_owner
MLuint32	_taskId
Friends
class	BackgroundTask

---

Detailed Description

BackgroundTaskStatusInformation creates a snapshot of the status of a given BackgroundTask, to allow later read access without races or even destruction of the background task (copyable).

Definition at line 24 of file mlBackgroundTaskStatusInformation.h.

---

Constructor & Destructor Documentation

ml::BackgroundTaskStatusInformation::BackgroundTaskStatusInformation

(

)

ml::BackgroundTaskStatusInformation::BackgroundTaskStatusInformation

(

BackgroundTask *

task

)

---

Member Function Documentation

void* ml::BackgroundTaskStatusInformation::owner

(

)

const [inline]

Definition at line 33 of file mlBackgroundTaskStatusInformation.h.

float ml::BackgroundTaskStatusInformation::progress

(

)

const [inline]

Definition at line 31 of file mlBackgroundTaskStatusInformation.h.

BackgroundTask::Status ml::BackgroundTaskStatusInformation::status

(

)

const [inline]

Definition at line 32 of file mlBackgroundTaskStatusInformation.h.

std::string ml::BackgroundTaskStatusInformation::statusString

(

)

const [inline]

Definition at line 30 of file mlBackgroundTaskStatusInformation.h.

MLuint32 ml::BackgroundTaskStatusInformation::taskId

(

)

const [inline]

Definition at line 34 of file mlBackgroundTaskStatusInformation.h.

---

Friends And Related Function Documentation

friend class BackgroundTask [friend]

Definition at line 37 of file mlBackgroundTaskStatusInformation.h.

---

Member Data Documentation

void* ml::BackgroundTaskStatusInformation::_owner [protected]

Definition at line 42 of file mlBackgroundTaskStatusInformation.h.

float ml::BackgroundTaskStatusInformation::_progress [protected]

Definition at line 40 of file mlBackgroundTaskStatusInformation.h.

BackgroundTask::Status ml::BackgroundTaskStatusInformation::_status [protected]

Definition at line 41 of file mlBackgroundTaskStatusInformation.h.

std::string ml::BackgroundTaskStatusInformation::_statusString [protected]

Definition at line 39 of file mlBackgroundTaskStatusInformation.h.

MLuint32 ml::BackgroundTaskStatusInformation::_taskId [protected]

Definition at line 43 of file mlBackgroundTaskStatusInformation.h.

---

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

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