MeVisLab Toolbox Reference
Public Member Functions | Protected Attributes | Friends | List of all members
ml::BackgroundTaskStatusInformation Class Reference

BackgroundTaskStatusInformation creates a snapshot of the status of a given BackgroundTask to allow for a later read access without race conditions or even destruction of the background task. More...

#include <mlBackgroundTaskStatusInformation.h>

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 for a later read access without race conditions or even destruction of the background task.

This is copyable.

Definition at line 25 of file mlBackgroundTaskStatusInformation.h.

Constructor & Destructor Documentation

◆ BackgroundTaskStatusInformation() [1/2]

ml::BackgroundTaskStatusInformation::BackgroundTaskStatusInformation ( )

◆ BackgroundTaskStatusInformation() [2/2]

ml::BackgroundTaskStatusInformation::BackgroundTaskStatusInformation ( BackgroundTask * task)

Member Function Documentation

◆ owner()

void * ml::BackgroundTaskStatusInformation::owner ( ) const
inline

Definition at line 34 of file mlBackgroundTaskStatusInformation.h.

◆ progress()

float ml::BackgroundTaskStatusInformation::progress ( ) const
inline

Definition at line 32 of file mlBackgroundTaskStatusInformation.h.

◆ status()

BackgroundTask::Status ml::BackgroundTaskStatusInformation::status ( ) const
inline

Definition at line 33 of file mlBackgroundTaskStatusInformation.h.

◆ statusString()

std::string ml::BackgroundTaskStatusInformation::statusString ( ) const
inline

Definition at line 31 of file mlBackgroundTaskStatusInformation.h.

◆ taskId()

MLuint32 ml::BackgroundTaskStatusInformation::taskId ( ) const
inline

Definition at line 35 of file mlBackgroundTaskStatusInformation.h.

Friends And Related Symbol Documentation

◆ BackgroundTask

friend class BackgroundTask
friend

Definition at line 38 of file mlBackgroundTaskStatusInformation.h.

Member Data Documentation

◆ _owner

void* ml::BackgroundTaskStatusInformation::_owner
protected

Definition at line 43 of file mlBackgroundTaskStatusInformation.h.

◆ _progress

float ml::BackgroundTaskStatusInformation::_progress
protected

Definition at line 41 of file mlBackgroundTaskStatusInformation.h.

◆ _status

BackgroundTask::Status ml::BackgroundTaskStatusInformation::_status
protected

Definition at line 42 of file mlBackgroundTaskStatusInformation.h.

◆ _statusString

std::string ml::BackgroundTaskStatusInformation::_statusString
protected

Definition at line 40 of file mlBackgroundTaskStatusInformation.h.

◆ _taskId

MLuint32 ml::BackgroundTaskStatusInformation::_taskId
protected

Definition at line 44 of file mlBackgroundTaskStatusInformation.h.

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