openCARP
Doxygen code documentation for the open cardiac electrophysiology simulator openCARP
Public Member Functions | List of all members
progress_percent< T > Class Template Reference

Display progress as a percentage. More...

#include <progress.hpp>

Inheritance diagram for progress_percent< T >:
Collaboration diagram for progress_percent< T >:

Public Member Functions

 progress_percent (T num_next, const char *msg, T start=60)
 
void next ()
 increment progress counter by one More...
 
void increment (T inc)
 increment progress counter by a custom value More...
 
void finish ()
 finish up progress display More...
 
- Public Member Functions inherited from progress< T >
 progress (T num_next, const char *msg)
 
virtual ~progress ()
 

Additional Inherited Members

- Protected Attributes inherited from progress< T >
_num_next
 number of times next will be triggered More...
 
std::string _msg
 message that will be displayed before progress information. More...
 

Detailed Description

template<class T>
class progress_percent< T >

Display progress as a percentage.

Template Parameters
TInteger type.

Definition at line 63 of file progress.hpp.

Constructor & Destructor Documentation

◆ progress_percent()

template<class T >
progress_percent< T >::progress_percent ( num_next,
const char *  msg,
start = 60 
)
inline

Definition at line 99 of file progress.hpp.

Member Function Documentation

◆ finish()

template<class T >
void progress_percent< T >::finish ( )
inlinevirtual

finish up progress display

Implements progress< T >.

Definition at line 126 of file progress.hpp.

◆ increment()

template<class T >
void progress_percent< T >::increment ( inc)
inlinevirtual

increment progress counter by a custom value

Implements progress< T >.

Definition at line 119 of file progress.hpp.

◆ next()

template<class T >
void progress_percent< T >::next ( )
inlinevirtual

increment progress counter by one

Implements progress< T >.

Definition at line 112 of file progress.hpp.


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