This is the documentation for Enlighten.
class Geo TxtProgressBar
- William Joseph
- geosw (Unlicensed)
class Geo::TxtProgressBar
  └>Geo::IGeoProgressProxy
A simple implementation of an IGeoProgressProxy that uses printf to communicate with the user.
Functions
| Name | Description |
|---|---|
| ~IGeoProgressProxy() | Virtual destructor. |
| Cancel() | Trigger a Cancel, which the ongoing process will check at various points during execution. |
| ReportError(const GeoError &) | Called when an error (or warning) is encountered by the task. |
| 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. |
| 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. |
| 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. |
| ShouldCancel() | Request a cancel of the current task. |
virtual Geo::IGeoProgressProxy::~IGeoProgressProxy
protected: virtual ~IGeoProgressProxy()
Virtual destructor.
void Geo::TxtProgressBar::Cancel
public: void Cancel()
Trigger a Cancel, which the ongoing process will check at various points during execution.
virtual void Geo::TxtProgressBar::ReportError
public: virtual 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::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::TxtProgressBar::SetProgressString
public: virtual void SetProgressString
(
  const char * desc
)
Called by progress tracked tasks to inform clients of the current (sub) task.
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::TxtProgressBar::SetProportionDone
public: virtual 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 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::TxtProgressBar::ShouldCancel
public: virtual 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.
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.