Progress counting


Functions

double goblinController::ProgressCounter () const throw ()
double goblinController::EstimatedExecutionTime () const throw ()
void moduleGuard::InitProgressCounter (double _maxProgress, double _step=1.0) throw ()
void moduleGuard::SetProgressMax (double _maxProgress) throw ()
void moduleGuard::SetProgressCounter (double currentProgress) throw ()
void moduleGuard::SetProgressNext (double step) throw ()
void moduleGuard::ProgressStep () throw ()
void moduleGuard::ProgressStep (double step) throw ()

Function Documentation

double EstimatedExecutionTime (   )  const throw () [inherited]
 

void InitProgressCounter (  double  _maxProgress,
double  _step = 1.0
)  throw () [inherited]
 

Initialize the progress counting facility.

Parameters:
_maxProgress The maximum progress value
_step The advance of progress in a single step
This sets the specified values, and also resets the current progress value.

double ProgressCounter (   )  const throw () [inherited]
 

void ProgressStep (  double  step  )  throw () [inherited]
 

Perform a progress feed.

Parameters:
step A relative progress value
The specified value is added on the current absolute progress value. It might differ from the forecasted value, but then discontinuity arises.

void ProgressStep (   )  throw () [inherited]
 

Perform the forecasted progress feed.

The value specified by the most recent SetProgressNext() call is added on the current absolute progress value.

void SetProgressCounter (  double  currentProgress  )  throw () [inherited]
 

Specify an absolute progress value.

Parameters:
currentProgress The current progress value
This ought to be in the range [0,maxProgress], and progress values are intended to be monotonically increasing.

void SetProgressMax (  double  _maxProgress  )  throw () [inherited]
 

Specify the total range of progress counting.

Parameters:
_maxProgress The maximum progress value
This sets the expected maximum progress value. This value can be lowered dynamically, provided that it does not fall short of the current progress value.

void SetProgressNext (  double  step  )  throw () [inherited]
 

Forecast the progress feed after the next iteration.

Parameters:
step The expected progress feed after the next iteration
This value is maintained as long as it is not updated. It tells about the upcoming ProgressStep() operations. The forecasting is important only if there are nested module calls which also implement progress counting. Then those nested progress values are scaled to subdivide a progress feed of the parent module context.