Progress bar with computation of the remaning time. More...

#include <ProgressTime.h>

Public Member Functions
void	finish ()
	affiche la barre de chargement finie

ProgressTime &	operator= (const ProgressTime &other)
	Opérateur = de ProgressTime.

void	print ()
	fonction qui affiche la ProgressTime

	ProgressTime ()
	Constructeur par défaut de ProgressTime.

	ProgressTime (const ProgressTime &other)
	constructeur de copie de ProgressTime

	ProgressTime (size_t nbSteps, char chPlein='=', char chMiddle='>', char chEnd=' ')
	Constructeur de ProgressTime.

void	setChEnd (char chEnd)
	init le charactère de remplissage de la barre vide

void	setChMiddle (char chMiddle)
	init le charactère au bout de la ligne de remplissage

void	setChPlein (char chPlein)
	init le caractère de remplissage

void	setNbSteps (size_t nbSteps)
	fonction qui initialise le nombre d'étapes à faire

void	start ()
	fonction qui démarre le chronomètre de la ProgressTime

virtual	~ProgressTime ()
	destructeur de ProgressTime

Private Member Functions
void	clear ()
	fonction qui efface la barre de chargement

void	copyProgressTime (const ProgressTime &other)
	fonction de copie de ProgressTime

void	feelbuffer (unsigned int taille)
	affiche la barre de chargement

void	initialisationProgressTime (size_t nbSteps, char chPlein, char chMiddle, char chEnd)
	fonction d'initialisation de ProgressTime

Private Attributes
unsigned int	p_avancement

char *	p_buffer
	Drawing buffer.

char	p_chEnd
	Character which fills the progress bar.

char	p_chMiddle
	Character at the end of the progress bar.

char	p_chPlein
	Character used to fill the progress bar.

unsigned int	p_consoleWidth

size_t	p_iCurrent

size_t	p_nbSteps

unsigned int	p_oldAvancement

clock_t	p_oldTempsRestant

unsigned int	p_pourcent

unsigned int	p_secondesRestantes

unsigned int	p_sizeBarr

clock_t	p_startTime

clock_t	p_tempsRestant

Detailed Description

Progress bar with computation of the remaning time.

Definition at line 15 of file ProgressTime.h.

Constructor & Destructor Documentation

◆ ProgressTime() [1/3]

ProgressTime::ProgressTime ( )

Constructeur par défaut de ProgressTime.

Cette fonction démarre le chronomètre par défaut

Definition at line 15 of file ProgressTime.cpp.

                          {
        initialisationProgressTime(0, '=', '>', ' ');
}

References initialisationProgressTime().

Referenced by copyProgressTime(), operator=(), and ProgressTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProgressTime() [2/3]

ProgressTime::ProgressTime	(	size_t	nbSteps,
		char	chPlein = '=',
		char	chMiddle = '>',
		char	chEnd = ' ' )

Constructeur de ProgressTime.

Parameters

nbSteps	: nombre d'étapes total à effectuer pour la barre de chargement
chPlein	: charactère de remplissage de la barre plein
chMiddle	: charactère au bout de la ligne de remplissage
chEnd	: charactère de remplissage de la barre vide Cette fonction démarre le chronomètre par défaut

Definition at line 26 of file ProgressTime.cpp.

                                                                                 {
        initialisationProgressTime(nbSteps, chPlein, chMiddle, chEnd);
}

References initialisationProgressTime().

Here is the call graph for this function:

◆ ProgressTime() [3/3]

ProgressTime::ProgressTime ( const ProgressTime & other )

constructeur de copie de ProgressTime

Parameters

other : ProgressTime à copier

Definition at line 33 of file ProgressTime.cpp.

                                                    {
        p_buffer = NULL;
        copyProgressTime(other);
}

References copyProgressTime(), p_buffer, and ProgressTime().

Here is the call graph for this function:

◆ ~ProgressTime()

ProgressTime::~ProgressTime ( )

virtual

destructeur de ProgressTime

Definition at line 39 of file ProgressTime.cpp.

                           {
        if(p_buffer != NULL){
                delete [] p_buffer;
        }
}

References p_buffer.

Member Function Documentation

◆ clear()

void ProgressTime::clear ( )

private

fonction qui efface la barre de chargement

Definition at line 181 of file ProgressTime.cpp.

                        {
        for(unsigned int i(0); i < p_sizeBarr; ++i){
                p_buffer[i] = '\r';
        }
        p_buffer[p_sizeBarr] = '\0';
}

References p_buffer, and p_sizeBarr.

Referenced by finish(), and print().

Here is the caller graph for this function:

◆ copyProgressTime()

void ProgressTime::copyProgressTime ( const ProgressTime & other )

private

fonction de copie de ProgressTime

Parameters

other : ProgressTime à copier

Definition at line 124 of file ProgressTime.cpp.

                                                             {
        if(p_buffer != NULL){
                delete [] p_buffer;
        }
        p_buffer = new char[other.p_sizeBarr + 1];                    //on pense au caractère \0
        p_startTime = other.p_startTime;
        p_tempsRestant = other.p_tempsRestant;
        p_nbSteps = other.p_nbSteps;
        p_iCurrent = other.p_iCurrent;
        p_avancement = other.p_avancement;
        p_oldAvancement = other.p_oldAvancement;
        p_secondesRestantes = other.p_secondesRestantes;
        p_oldTempsRestant = other.p_oldTempsRestant;
        p_consoleWidth = other.p_consoleWidth;
        p_pourcent = other.p_pourcent;
        p_sizeBarr = other.p_sizeBarr;
        p_chPlein = other.p_chPlein;
        p_chMiddle = other.p_chMiddle;
        p_chEnd = other.p_chEnd;
        
        p_buffer[p_sizeBarr] = '\0';
}

References p_avancement, p_buffer, p_chEnd, p_chMiddle, p_chPlein, p_consoleWidth, p_iCurrent, p_nbSteps, p_oldAvancement, p_oldTempsRestant, p_pourcent, p_secondesRestantes, p_sizeBarr, p_startTime, p_tempsRestant, and ProgressTime().

Referenced by operator=(), and ProgressTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ feelbuffer()

void ProgressTime::feelbuffer ( unsigned int taille )

private

affiche la barre de chargement

Parameters

taille : taille de la barre à afficher

Definition at line 167 of file ProgressTime.cpp.

                                                {
        if(taille <= p_sizeBarr){
                for(unsigned int i(0); i < taille; ++i){
                        p_buffer[i] = p_chPlein;
                }
                p_buffer[taille] = p_chMiddle;
        }
        for(unsigned int i(taille + 1); i <= p_sizeBarr; ++i){
                p_buffer[i] = p_chEnd;
        }
        p_buffer[p_sizeBarr] = '\0';
}

References p_buffer, p_chEnd, p_chMiddle, p_chPlein, and p_sizeBarr.

Referenced by finish(), and print().

Here is the caller graph for this function:

◆ finish()

void ProgressTime::finish ( )

affiche la barre de chargement finie

Definition at line 76 of file ProgressTime.cpp.

                         {
        clear();
        std::cerr << "\r" << p_buffer << "\r\r\r\r";
        feelbuffer(p_sizeBarr);
        std::cerr << "[" << p_buffer << "|" << p_pourcent << "%] " << p_secondesRestantes << "s";
        std::cerr << std::endl;
}

References clear(), feelbuffer(), p_buffer, p_pourcent, p_secondesRestantes, and p_sizeBarr.

Here is the call graph for this function:

◆ initialisationProgressTime()

void ProgressTime::initialisationProgressTime	(	size_t	nbSteps,
		char	chPlein,
		char	chMiddle,
		char	chEnd )

private

fonction d'initialisation de ProgressTime

Parameters

nbSteps	: nombre d'étapes à faire pour arriver à 100%
chPlein	: caractère de remplissage de la barre de chargement
chMiddle	: caractère entre la partie vide et la partie remplie de la barre de chargement
chEnd	: caractère de la partie vide de la barre de chargement

Definition at line 153 of file ProgressTime.cpp.

                                                                                                    {
        p_nbSteps = nbSteps;
        p_chPlein = chPlein;
        p_chMiddle = chMiddle;
        p_chEnd = chEnd;
        start();
        p_consoleWidth = phoenix_getNbColTerminal();
        p_sizeBarr = (3u*p_consoleWidth)/4u; //on prend 3/4 de la taille de la console
        p_buffer = new char[p_sizeBarr + 1u];
}

References p_buffer, p_chEnd, p_chMiddle, p_chPlein, p_consoleWidth, p_nbSteps, p_sizeBarr, and start().

Referenced by ProgressTime(), and ProgressTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

ProgressTime & ProgressTime::operator= ( const ProgressTime & other )

Opérateur = de ProgressTime.

Parameters

other : ProgressTime à copier

Returns: ProgressTime copié

Definition at line 116 of file ProgressTime.cpp.

                                                                  {
        copyProgressTime(other);
        return *this;
}

References copyProgressTime(), and ProgressTime().

Here is the call graph for this function:

◆ print()

void ProgressTime::print ( )

fonction qui affiche la ProgressTime

Definition at line 56 of file ProgressTime.cpp.

                        {
        ++p_iCurrent;
        p_avancement = (p_iCurrent*p_sizeBarr)/p_nbSteps;
        p_tempsRestant = (clock_t)(((clock() - p_startTime)*((clock_t)(p_nbSteps - p_iCurrent)))/((clock_t)p_iCurrent));
        if(p_oldAvancement != p_avancement || p_oldTempsRestant != p_tempsRestant){
                p_pourcent = (p_iCurrent*100)/p_nbSteps;
                //on efface la ligne de la console où il y a la barre de chargement
                clear();
                std::cerr << "\r" << p_buffer << "\r\r\r\r";
                //on affiche la barre de chargement
                feelbuffer(p_avancement);
                p_secondesRestantes = p_tempsRestant/CLOCKS_PER_SEC;
                std::cerr << "[" << p_buffer << "|" << p_pourcent << "%] " << p_secondesRestantes << "s";
                //on met old_taille à jour
                p_oldAvancement = p_avancement;
                p_oldTempsRestant = p_tempsRestant;
        }
}

References clear(), feelbuffer(), p_avancement, p_buffer, p_iCurrent, p_nbSteps, p_oldAvancement, p_oldTempsRestant, p_pourcent, p_secondesRestantes, p_sizeBarr, p_startTime, and p_tempsRestant.

Here is the call graph for this function:

◆ setChEnd()

void ProgressTime::setChEnd ( char chEnd )

init le charactère de remplissage de la barre vide

Parameters

chEnd : charactère de remplissage de la barre vide

Definition at line 108 of file ProgressTime.cpp.

                                     {
        p_chEnd = chEnd;
}

References p_chEnd.

◆ setChMiddle()

void ProgressTime::setChMiddle ( char chMiddle )

init le charactère au bout de la ligne de remplissage

Parameters

chMiddle : charactère au bout de la ligne de remplissage

Definition at line 101 of file ProgressTime.cpp.

                                           {
        p_chMiddle = chMiddle;
}

References p_chMiddle.

◆ setChPlein()

void ProgressTime::setChPlein ( char chPlein )

init le caractère de remplissage

Parameters

chPlein : caractère de remplissage

Definition at line 94 of file ProgressTime.cpp.

                                         {
        p_chPlein = chPlein;
}

References p_chPlein.

◆ setNbSteps()

void ProgressTime::setNbSteps ( size_t nbSteps )

fonction qui initialise le nombre d'étapes à faire

Parameters

nbSteps : nombre d'étapes à faire pour arriver à 100%

Definition at line 87 of file ProgressTime.cpp.

                                           {
        p_nbSteps = nbSteps;
}

References p_nbSteps.

◆ start()

void ProgressTime::start ( )

fonction qui démarre le chronomètre de la ProgressTime

Definition at line 46 of file ProgressTime.cpp.

                        {
        p_startTime = clock();
        p_iCurrent = 0;
        p_oldAvancement = 0;
        p_avancement = 0;
        p_secondesRestantes = 0;
        p_oldTempsRestant = 0;
}

References p_avancement, p_iCurrent, p_oldAvancement, p_oldTempsRestant, p_secondesRestantes, and p_startTime.

Referenced by initialisationProgressTime().

Here is the caller graph for this function:

Member Data Documentation

◆ p_avancement

unsigned int ProgressTime::p_avancement

private

Definition at line 44 of file ProgressTime.h.

Referenced by copyProgressTime(), print(), and start().

◆ p_buffer

char* ProgressTime::p_buffer

private

Drawing buffer.

Definition at line 59 of file ProgressTime.h.

Referenced by clear(), copyProgressTime(), feelbuffer(), finish(), initialisationProgressTime(), print(), ProgressTime(), and ~ProgressTime().

◆ p_chEnd

char ProgressTime::p_chEnd

private

Character which fills the progress bar.

Definition at line 57 of file ProgressTime.h.

Referenced by copyProgressTime(), feelbuffer(), initialisationProgressTime(), and setChEnd().

◆ p_chMiddle

char ProgressTime::p_chMiddle

private

Character at the end of the progress bar.

Definition at line 55 of file ProgressTime.h.

Referenced by copyProgressTime(), feelbuffer(), initialisationProgressTime(), and setChMiddle().

◆ p_chPlein

char ProgressTime::p_chPlein

private

Character used to fill the progress bar.

Definition at line 53 of file ProgressTime.h.

Referenced by copyProgressTime(), feelbuffer(), initialisationProgressTime(), and setChPlein().

◆ p_consoleWidth

unsigned int ProgressTime::p_consoleWidth

private

Definition at line 48 of file ProgressTime.h.

Referenced by copyProgressTime(), and initialisationProgressTime().

◆ p_iCurrent

size_t ProgressTime::p_iCurrent

private

Definition at line 43 of file ProgressTime.h.

Referenced by copyProgressTime(), print(), and start().

◆ p_nbSteps

size_t ProgressTime::p_nbSteps

private

Definition at line 42 of file ProgressTime.h.

Referenced by copyProgressTime(), initialisationProgressTime(), print(), and setNbSteps().

◆ p_oldAvancement

unsigned int ProgressTime::p_oldAvancement

private

Definition at line 45 of file ProgressTime.h.

Referenced by copyProgressTime(), print(), and start().

◆ p_oldTempsRestant

clock_t ProgressTime::p_oldTempsRestant

private

Definition at line 47 of file ProgressTime.h.

Referenced by copyProgressTime(), print(), and start().

◆ p_pourcent

unsigned int ProgressTime::p_pourcent

private

Definition at line 49 of file ProgressTime.h.

Referenced by copyProgressTime(), finish(), and print().

◆ p_secondesRestantes

unsigned int ProgressTime::p_secondesRestantes

private

Definition at line 46 of file ProgressTime.h.

Referenced by copyProgressTime(), finish(), print(), and start().

◆ p_sizeBarr

unsigned int ProgressTime::p_sizeBarr

private

Definition at line 50 of file ProgressTime.h.

Referenced by clear(), copyProgressTime(), feelbuffer(), finish(), initialisationProgressTime(), and print().

◆ p_startTime

clock_t ProgressTime::p_startTime

private

Definition at line 40 of file ProgressTime.h.

Referenced by copyProgressTime(), print(), and start().

◆ p_tempsRestant

clock_t ProgressTime::p_tempsRestant

private

Definition at line 41 of file ProgressTime.h.

Referenced by copyProgressTime(), and print().

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

/builds/CTA-LAPP/PHOENIX_LIBS2/display/PhoenixProgress/src/ProgressTime.h
/builds/CTA-LAPP/PHOENIX_LIBS2/display/PhoenixProgress/src/ProgressTime.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ProgressTime() [1/3]

◆ ProgressTime() [2/3]

◆ ProgressTime() [3/3]

◆ ~ProgressTime()

Member Function Documentation

◆ clear()

◆ copyProgressTime()

◆ feelbuffer()

◆ finish()

◆ initialisationProgressTime()

◆ operator=()

◆ print()

◆ setChEnd()

◆ setChMiddle()

◆ setChPlein()

◆ setNbSteps()

◆ start()

Member Data Documentation

◆ p_avancement

◆ p_buffer

◆ p_chEnd

◆ p_chMiddle

◆ p_chPlein

◆ p_consoleWidth

◆ p_iCurrent

◆ p_nbSteps

◆ p_oldAvancement

◆ p_oldTempsRestant

◆ p_pourcent

◆ p_secondesRestantes

◆ p_sizeBarr

◆ p_startTime

◆ p_tempsRestant