ProgressTime Class Reference

classe qui permet de gérer des barres de chargement en console avec l'affichage et le calcul du temps restant More...

#include <ProgressTime.h>

Public Member Functions
void	finish ()
	affiche la barre de chargement finie More...
ProgressTime &	operator= (const ProgressTime &other)
	Opérateur = de ProgressTime. More...
void	print ()
	fonction qui affiche la ProgressTime More...
	ProgressTime ()
	Constructeur par défaut de ProgressTime. More...
	ProgressTime (const ProgressTime &other)
	constructeur de copie de ProgressTime More...
	ProgressTime (size_t nbSteps, char chPlein='=', char chMiddle='>', char chEnd=' ')
	Constructeur de ProgressTime. More...
void	setChEnd (char chEnd)
	init le charactère de remplissage de la barre vide More...
void	setChMiddle (char chMiddle)
	init le charactère au bout de la ligne de remplissage More...
void	setChPlein (char chPlein)
	init le caractère de remplissage More...
void	setNbSteps (size_t nbSteps)
	fonction qui initialise le nombre d'étapes à faire More...
void	start ()
	fonction qui démarre le chronomètre de la ProgressTime More...
virtual	~ProgressTime ()
	destructeur de ProgressTime More...

Private Member Functions
void	clear ()
	fonction qui efface la barre de chargement More...
void	copyProgressTime (const ProgressTime &other)
	fonction de copie de ProgressTime More...
void	feelbuffer (unsigned int taille)
	affiche la barre de chargement More...
void	initialisationProgressTime (size_t nbSteps, char chPlein, char chMiddle, char chEnd)
	fonction d'initialisation de ProgressTime More...

Private Attributes
unsigned int	p_avancement
char *	p_buffer
	tampon pour l'affichage More...
char	p_chEnd
	charactère de remplissage de la barre vide More...
char	p_chMiddle
	charactère au bout de la ligne de remplissage More...
char	p_chPlein
	caractère de remplissage More...
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

classe qui permet de gérer des barres de chargement en console avec l'affichage et le calcul du temps restant

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 16 of file ProgressTime.cpp.

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

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 27 of file ProgressTime.cpp.

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

ProgressTime() [3/3]

ProgressTime::ProgressTime

(

const ProgressTime &

other

)

constructeur de copie de ProgressTime

Parameters

other

: ProgressTime à copier

Definition at line 34 of file ProgressTime.cpp.

                                                    {
        p_buffer = NULL;
        copyProgressTime(other);
}

~ProgressTime()

ProgressTime::~ProgressTime ( )

virtual

destructeur de ProgressTime

Definition at line 40 of file ProgressTime.cpp.

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

Member Function Documentation

clear()

void ProgressTime::clear ( )

private

fonction qui efface la barre de chargement

Definition at line 182 of file ProgressTime.cpp.

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

copyProgressTime()

void ProgressTime::copyProgressTime ( const ProgressTime &  other )

private

fonction de copie de ProgressTime

Parameters

other

: ProgressTime à copier

Definition at line 125 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_chEnd, p_chMiddle, p_chPlein, p_consoleWidth, p_iCurrent, p_nbSteps, p_oldAvancement, p_oldTempsRestant, p_pourcent, p_secondesRestantes, p_sizeBarr, p_startTime, and p_tempsRestant.

feelbuffer()

void ProgressTime::feelbuffer ( unsigned int  taille )

private

affiche la barre de chargement

Parameters

taille

: taille de la barre à afficher

Definition at line 168 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';
}

finish()

void ProgressTime::finish

(

)

affiche la barre de chargement finie

Definition at line 77 of file ProgressTime.cpp.

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

Referenced by testProgressTime().

Here is the caller 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 154 of file ProgressTime.cpp.

                                                                                                    {
        p_nbSteps = nbSteps;
        p_chPlein = chPlein;
        p_chMiddle = chMiddle;
        p_chEnd = chEnd;
        start();
        p_consoleWidth = 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 getNbColTerminal().

Here is the call 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 117 of file ProgressTime.cpp.

                                                                  {
        copyProgressTime(other);
        return *this;
}

print()

void ProgressTime::print

(

)

fonction qui affiche la ProgressTime

Definition at line 57 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();
                cerr << "\r" << p_buffer << "\r\r\r\r";
                //on affiche la barre de chargement
                feelbuffer(p_avancement);
                p_secondesRestantes = p_tempsRestant/CLOCKS_PER_SEC;
                cerr << "[" << p_buffer << "|" << p_pourcent << "%] " << p_secondesRestantes << "s";
                //on met old_taille à jour
                p_oldAvancement = p_avancement;
                p_oldTempsRestant = p_tempsRestant;
        }
}

Referenced by testProgressTime().

Here is the caller 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 109 of file ProgressTime.cpp.

                                     {
        p_chEnd = chEnd;
}

Referenced by testProgressTime().

Here is the caller graph for this function:

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 102 of file ProgressTime.cpp.

                                           {
        p_chMiddle = chMiddle;
}

Referenced by testProgressTime().

Here is the caller graph for this function:

setChPlein()

void ProgressTime::setChPlein

(

char

chPlein

)

init le caractère de remplissage

Parameters

chPlein

: caractère de remplissage

Definition at line 95 of file ProgressTime.cpp.

                                         {
        p_chPlein = chPlein;
}

Referenced by testProgressTime().

Here is the caller graph for this function:

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 88 of file ProgressTime.cpp.

                                           {
        p_nbSteps = nbSteps;
}

Referenced by testProgressTime().

Here is the caller graph for this function:

start()

void ProgressTime::start

(

)

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

Definition at line 47 of file ProgressTime.cpp.

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

Referenced by testProgressTime().

Here is the caller graph for this function:

Member Data Documentation

p_avancement

unsigned int ProgressTime::p_avancement

private

Definition at line 48 of file ProgressTime.h.

Referenced by copyProgressTime().

p_buffer

char* ProgressTime::p_buffer

private

tampon pour l'affichage

Definition at line 63 of file ProgressTime.h.

p_chEnd

char ProgressTime::p_chEnd

private

charactère de remplissage de la barre vide

Definition at line 61 of file ProgressTime.h.

Referenced by copyProgressTime().

p_chMiddle

char ProgressTime::p_chMiddle

private

charactère au bout de la ligne de remplissage

Definition at line 59 of file ProgressTime.h.

Referenced by copyProgressTime().

p_chPlein

char ProgressTime::p_chPlein

private

caractère de remplissage

Definition at line 57 of file ProgressTime.h.

Referenced by copyProgressTime().

p_consoleWidth

unsigned int ProgressTime::p_consoleWidth

private

Definition at line 52 of file ProgressTime.h.

Referenced by copyProgressTime().

p_iCurrent

size_t ProgressTime::p_iCurrent

private

Definition at line 47 of file ProgressTime.h.

Referenced by copyProgressTime().

p_nbSteps

size_t ProgressTime::p_nbSteps

private

Definition at line 46 of file ProgressTime.h.

Referenced by copyProgressTime().

p_oldAvancement

unsigned int ProgressTime::p_oldAvancement

private

Definition at line 49 of file ProgressTime.h.

Referenced by copyProgressTime().

p_oldTempsRestant

clock_t ProgressTime::p_oldTempsRestant

private

Definition at line 51 of file ProgressTime.h.

Referenced by copyProgressTime().

p_pourcent

unsigned int ProgressTime::p_pourcent

private

Definition at line 53 of file ProgressTime.h.

Referenced by copyProgressTime().

p_secondesRestantes

unsigned int ProgressTime::p_secondesRestantes

private

Definition at line 50 of file ProgressTime.h.

Referenced by copyProgressTime().

p_sizeBarr

unsigned int ProgressTime::p_sizeBarr

private

Definition at line 54 of file ProgressTime.h.

Referenced by copyProgressTime().

p_startTime

clock_t ProgressTime::p_startTime

private

Definition at line 44 of file ProgressTime.h.

Referenced by copyProgressTime().

p_tempsRestant

clock_t ProgressTime::p_tempsRestant

private

Definition at line 45 of file ProgressTime.h.

Referenced by copyProgressTime().

---

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

• /builds/CTA-LAPP/PHOENIX_LIBS/PhoenixMock/tmp_project/StringUtils/src/ProgressTime.h
• /builds/CTA-LAPP/PHOENIX_LIBS/PhoenixMock/tmp_project/StringUtils/src/ProgressTime.cpp