EDoc::StdErrFunctionProgress Class Reference

#include <include/EDoc/StdErrFunctionProgress.h>

Inheritance diagram for EDoc::StdErrFunctionProgress:

EDoc::ProgressIFace< T >

Detailed Description

Displays a progress indication for functions being processed to stderr.

This will display the progress to stderr in a format like:

xxx/yyy : FunctionName

Definition at line 35 of file StdErrFunctionProgress.h.

Public Member Functions

virtual void Start (size_t total)
 See ProgressIFace::Start().
virtual void Progress (Function *data)
 See ProgressIFace::Progress().
virtual void Progress (T *data)=0
 Called each time some progress is made that is to be shown to the user.

Data Fields

size_t current
size_t total


Member Function Documentation

EDoc::StdErrFunctionProgress::Start ( size_t  total  )  [virtual]

See ProgressIFace::Start().

Note:
EDoc++ data included.

Implements EDoc::ProgressIFace< T >.

Definition at line 31 of file StdErrFunctionProgress.cpp.

References current, and total.

EDoc::StdErrFunctionProgress::Progress ( EDoc::Function data  )  [virtual]

See ProgressIFace::Progress().

Note:
EDoc++ data included.

Definition at line 37 of file StdErrFunctionProgress.cpp.

References current, EDoc::StringIdentifiedObject::GetKeyName(), and total.

template<typename T>
virtual void EDoc::ProgressIFace< T >::Progress ( T *  data  )  [pure virtual, inherited]

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().


Field Documentation

size_t EDoc::StdErrFunctionProgress::current

Definition at line 53 of file StdErrFunctionProgress.h.

Referenced by Progress(), and Start().

size_t EDoc::StdErrFunctionProgress::total

Definition at line 54 of file StdErrFunctionProgress.h.

Referenced by Progress(), and Start().


The documentation for this class was generated from the following files:
Generated on Tue Jan 20 18:26:09 2009 for EDoc-0.2.1 by  doxygen 1.5.1