golib  0.5
Public Member Functions | Protected Member Functions | List of all members
goStatusObject Class Reference
Miscellaneous and basic classes

Provides status information for an object INCOMPLETE. More...

#include <gostatusobject.h>

Public Member Functions

bool isBusy ()
 
goFloat getProgress ()
 
goFloat getMaxProgress ()
 
goFloat getMinProgress ()
 
goFloat waitForProgress ()
 
void forwardProgress (goStatusObject *s)
 
void forwardProgressThread ()
 
void forwardProgressEnd ()
 

Protected Member Functions

void setBusy (bool b)
 
void setProgress (goFloat p)
 
void signalProgress ()
 

Detailed Description

Provides status information for an object INCOMPLETE.

Todo:
Fix this class when there is a use for it. It is not complete and tested.
Author
Christian Gosch
Date
21.9.2001

Member Function Documentation

◆ getProgress()

goFloat goStatusObject::getProgress ( )
inline
Returns
A value representing the progress in some work being done by the object. This will usually be something between 0 and 1, but can generally be whatever value is allowed by goFloat.

◆ isBusy()

bool goStatusObject::isBusy ( )
inline
Returns
True if this object is busy, false otherwise.

◆ setBusy()

void goStatusObject::setBusy ( bool  b)
inlineprotected

Sets the busy flag.

Parameters
bValue of the busy flag

◆ setProgress()

void goStatusObject::setProgress ( goFloat  p)
inlineprotected

Sets the progress value.

Parameters
pProgress value, should usually be between 0 and 1, but there is no general restriction.

◆ waitForProgress()

goFloat goStatusObject::waitForProgress ( )
inline

Uses a semaphore to suspend the calling thread until the mutex is released.

Returns
The current progress.
The documentation for this class was generated from the following files: