MeVisLab Toolbox Reference
ml::BackgroundTaskStatusInformation Class Reference

#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)

References BackgroundTask.

Member Function Documentation

◆ owner()

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

Definition at line 34 of file mlBackgroundTaskStatusInformation.h.

References _owner.

◆ progress()

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

Definition at line 32 of file mlBackgroundTaskStatusInformation.h.

References _progress.

◆ status()

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

Definition at line 33 of file mlBackgroundTaskStatusInformation.h.

References _status.

◆ statusString()

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

Definition at line 31 of file mlBackgroundTaskStatusInformation.h.

References _statusString.

◆ taskId()

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

Definition at line 35 of file mlBackgroundTaskStatusInformation.h.

References _taskId.

◆ BackgroundTask

friend class BackgroundTask
friend

Definition at line 38 of file mlBackgroundTaskStatusInformation.h.

References BackgroundTask.

Referenced by BackgroundTask, and BackgroundTaskStatusInformation().

Member Data Documentation

◆ _owner

void* ml::BackgroundTaskStatusInformation::_owner
protected

Definition at line 43 of file mlBackgroundTaskStatusInformation.h.

Referenced by owner().

◆ _progress

float ml::BackgroundTaskStatusInformation::_progress
protected

Definition at line 41 of file mlBackgroundTaskStatusInformation.h.

Referenced by progress().

◆ _status

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

Definition at line 42 of file mlBackgroundTaskStatusInformation.h.

Referenced by status().

◆ _statusString

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

Definition at line 40 of file mlBackgroundTaskStatusInformation.h.

Referenced by statusString().

◆ _taskId

MLuint32 ml::BackgroundTaskStatusInformation::_taskId
protected

Definition at line 44 of file mlBackgroundTaskStatusInformation.h.

Referenced by taskId().

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