EDoc::ProgressIFace< T > Class Template Reference

#include <include/EDoc/ProgressIFace.h>

Inheritance diagram for EDoc::ProgressIFace< T >:

---

Detailed Description

template<typename T>
class EDoc::ProgressIFace< T >

Interface used for giving progress indication on a task.

Definition at line 30 of file ProgressIFace.h.

Public Member Functions
virtual	~ProgressIFace ()
	Destructor.
virtual void	Start (size_t total)=0
	Called to start the progress indication.
virtual void	Progress (T *data)=0
	Called each time some progress is made that is to be shown to the user.

---

Constructor & Destructor Documentation

template<typename T>

virtual EDoc::ProgressIFace< T >::~ProgressIFace

(

)

[inline, virtual]

Destructor.

Definition at line 37 of file ProgressIFace.h.

---

Member Function Documentation

template<typename T>

virtual void EDoc::ProgressIFace< T >::Start

(

size_t

total

)

[pure virtual]

Called to start the progress indication.

Parameters:

total

indicates the total number of times that the Progress() function will be called to reach 100% progress.

Implemented in EDoc::ProgressBar, and EDoc::StdErrFunctionProgress.

Referenced by EDoc::Dictionary::CalculatePropogatingExceptions().

template<typename T>

virtual void EDoc::ProgressIFace< T >::Progress

(

T *

data

)

[pure virtual]

Called each time some progress is made that is to be shown to the user.

Note: This must be called exactly total number of times, where total is the value passed to the Start() function.

Referenced by EDoc::Dictionary::GenerateExceptions().

---

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

• include/EDoc/ProgressIFace.h

---