LTIProgressDelegate Class Reference

progress delegate (callback) base class More...

#include <lti_delegates.h>

List of all members.

Public Member Functions

virtual ~LTIProgressDelegate (void)
virtual LT_STATUS setProgressStatus (float percentComplete)=0
 set percent completed


Detailed Description

This abstract class is used for implementing a mechanism to report the progress (percent complete) of a potentially long-running operation. During these sorts of operations, an object which has a progress delegate may periodically call the delegate's setProgressStatus() method to report the percent of the operation completed.

Progress delegates are typically used in GUI environments as a means of displaying percent-complete or time-remaining.

A "delegate" is simply an object-oriented version of a callback function.

Examples:

ProgressDelegate.cpp.

Definition at line 72 of file lti_delegates.h.


Constructor & Destructor Documentation

virtual LTIProgressDelegate::~LTIProgressDelegate ( void   )  [virtual]


Member Function Documentation

virtual LT_STATUS LTIProgressDelegate::setProgressStatus ( float  percentComplete  )  [pure virtual]

This function should be implemented to report to the client application the progress of a long-running operation.

Parameters:
percentComplete the percent complete; this must be a value in the range 0.0 to 1.0 inclusive
Returns:
LT_STS_Success if function succeeded, nonzero if some error occurred
Examples:
ProgressDelegate.cpp.


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

LizardTech