This is the documentation for Enlighten.
class Geo IGeoProgressProxy
- geosw (Unlicensed)
class Geo::IGeoProgressProxy
An interface for informing a client about the current progress of an operation.
Functions
| Name | Description |
|---|---|
| ~IGeoProgressProxy() | Virtual destructor. |
| ReportError(const GeoError &) | Called when an error (or warning) is encountered by the task. |
| SetProgressString(const char *) | Called by progress tracked tasks to inform clients of the current (sub) task. |
| SetProportionDone(float) | Called when a further chunk of work has been performed on the current (sub) task. |
| ShouldCancel() | Request a cancel of the current task. |
virtual Geo::IGeoProgressProxy::~IGeoProgressProxy
protected: virtual ~IGeoProgressProxy()
Virtual destructor.
virtual void Geo::IGeoProgressProxy::ReportError
public: void ReportError
(
  const GeoError & error
)
Called when an error (or warning) is encountered by the task.
Details of the error can be found in the Error struct. The Error struct is valid only for the lifetime of the call to ReportError and cannot be copied.
virtual void Geo::IGeoProgressProxy::SetProgressString
public: void SetProgressString
(
  const char * desc
)
Called by progress tracked tasks to inform clients of the current (sub) task.
virtual void Geo::IGeoProgressProxy::SetProportionDone
public: void SetProportionDone
(
  float globalProgress
)
Called when a further chunk of work has been performed on the current (sub) task.
Parameters
| [in] | globalProgress | The total percentage of work completed on this task [0,1]. |
virtual bool Geo::IGeoProgressProxy::ShouldCancel
public: bool ShouldCancel()
Request a cancel of the current task.
This function will be called periodically by progress tracked tasks. Use this opportunity to request a halt to the current task.