openCARP
Doxygen code documentation for the open cardiac electrophysiology simulator openCARP
Public Member Functions | Protected Attributes | List of all members
progress< T > Class Template Referenceabstract

Base class for tracking progress. More...

#include <progress.hpp>

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

Public Member Functions

 progress (T num_next, const char *msg)
 
virtual ~progress ()
 
virtual void next ()=0
 
virtual void increment (T inc)=0
 
virtual void finish ()=0
 

Protected Attributes

_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< T >

Base class for tracking progress.

Template Parameters
TInteger type

Definition at line 38 of file progress.hpp.

Constructor & Destructor Documentation

◆ progress()

template<class T >
progress< T >::progress ( num_next,
const char *  msg 
)
inline

Definition at line 45 of file progress.hpp.

◆ ~progress()

template<class T >
virtual progress< T >::~progress ( )
inlinevirtual

Definition at line 49 of file progress.hpp.

Member Function Documentation

◆ finish()

template<class T >
virtual void progress< T >::finish ( )
pure virtual

Implemented in progress_bar< T >, and progress_percent< T >.

Here is the caller graph for this function:

◆ increment()

template<class T >
virtual void progress< T >::increment ( inc)
pure virtual

Implemented in progress_bar< T >, and progress_percent< T >.

Here is the caller graph for this function:

◆ next()

template<class T >
virtual void progress< T >::next ( )
pure virtual

Implemented in progress_bar< T >, and progress_percent< T >.

Here is the caller graph for this function:

Member Data Documentation

◆ _msg

template<class T >
std::string progress< T >::_msg
protected

message that will be displayed before progress information.

Definition at line 42 of file progress.hpp.

◆ _num_next

template<class T >
T progress< T >::_num_next
protected

number of times next will be triggered

Definition at line 41 of file progress.hpp.


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