Classic progress bar in the terminal. More...

#include <ProgressBarr.h>

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

char	getChEnd () const
	retourne le charactère de remplissage de la barre vide

char	getChMiddle () const
	retourne le charactère au bout de la ligne de remplissage

char	getChPlein () const
	retourne le caractère de remplissage

size_t	getMax () const
	retourne la valeur max atteinte par la barre

size_t	getSize () const
	retourne la taille maximale de la barre

ProgressBarr &	operator= (const ProgressBarr &progressBarr)
	redéfinition de l'opérateur =

void	progress (size_t avencement)
	fonction qui fait avancer (ou reculer) la barre de chargement

	ProgressBarr (const ProgressBarr &progressBarr)
	constreucteur de copie de la barre de progression

	ProgressBarr (size_t max=100, size_t size=100, char chPlein='=', char chMiddle='>', char chEnd=' ')
	constructeur de la barre de progression en console

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	setMax (size_t max)
	init la valeur max atteinte par la barre

void	setSize (size_t size)
	init la taille de la barre

virtual	~ProgressBarr ()
	destructeur de la barre de progression

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

void	copy (const ProgressBarr &progressBarr)
	fonction qui copie la barre de chargement

void	feelbuffer (size_t taille)
	affiche la barre de chargement

Protected Attributes
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.

size_t	p_max
	Maximum value to reach to complete charging.

size_t	p_old_taille
	Previous size of the progress bar.

size_t	p_size
	Maximum size of the progress bar.

Private Member Functions
void	init (size_t max, size_t size, char chPlein, char chMiddle, char chEnd)
	Initialisation de la barre de progression en console.

Detailed Description

Classic progress bar in the terminal.

Definition at line 14 of file ProgressBarr.h.

Constructor & Destructor Documentation

◆ ProgressBarr() [1/2]

ProgressBarr::ProgressBarr	(	size_t	max = 100,
		size_t	size = 100,
		char	chPlein = '=',
		char	chMiddle = '>',
		char	chEnd = ' ' )

constructeur de la barre de progression en console

Parameters

max	: valeur maximale atteinte par barre de progression pleine
size	: taille de 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

Definition at line 16 of file ProgressBarr.cpp.

                                                                                          {
        init(max, size, chPlein, chMiddle, chEnd);
}

References init().

Referenced by copy(), operator=(), and ProgressBarr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProgressBarr() [2/2]

ProgressBarr::ProgressBarr ( const ProgressBarr & progressBarr )

constreucteur de copie de la barre de progression

Parameters

progressBarr : barre de progression à copier

Definition at line 24 of file ProgressBarr.cpp.

                                                           {
        p_buffer = NULL;
        copy(progressBarr);
}

References copy(), p_buffer, and ProgressBarr().

Here is the call graph for this function:

◆ ~ProgressBarr()

ProgressBarr::~ProgressBarr ( )

virtual

destructeur de la barre de progression

Definition at line 30 of file ProgressBarr.cpp.

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

References p_buffer.

Member Function Documentation

◆ clear()

void ProgressBarr::clear ( )

protected

fonction qui efface la barre de chargement

Definition at line 189 of file ProgressBarr.cpp.

                        {
        for(size_t i = 0; i < p_size; ++i){
                p_buffer[i] = '\r';
        }
        p_buffer[p_size] = '\0';
}

References p_buffer, and p_size.

Referenced by progress().

Here is the caller graph for this function:

◆ copy()

void ProgressBarr::copy ( const ProgressBarr & progressBarr )

protected

fonction qui copie la barre de chargement

Parameters

progressBarr : barre de chargement à copier

Definition at line 159 of file ProgressBarr.cpp.

                                                        {
        if(p_buffer != NULL){
                delete [] p_buffer;
        }
        p_buffer = new char[progressBarr.p_size + 1];                    //on pense au caractère \0
        p_size = progressBarr.p_size;
        p_max = progressBarr.p_max;
        p_chPlein = progressBarr.p_chPlein;
        p_chMiddle = progressBarr.p_chMiddle;
        p_chEnd = progressBarr.p_chEnd;
        p_old_taille = progressBarr.p_old_taille;
}

References p_buffer, p_chEnd, p_chMiddle, p_chPlein, p_max, p_old_taille, p_size, and ProgressBarr().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ feelbuffer()

void ProgressBarr::feelbuffer ( size_t taille )

protected

affiche la barre de chargement

Parameters

taille : taille de la barre à afficher

Definition at line 175 of file ProgressBarr.cpp.

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

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

Referenced by progress().

Here is the caller graph for this function:

◆ finish()

void ProgressBarr::finish ( )

affiche la barre de chargement finie

Definition at line 126 of file ProgressBarr.cpp.

                         {
        progress(p_max);
        std::cout << std::endl;
}

References p_max, and progress().

Here is the call graph for this function:

◆ getChEnd()

char ProgressBarr::getChEnd ( ) const

retourne le charactère de remplissage de la barre vide

Returns: charactère de remplissage de la barre vide

Definition at line 86 of file ProgressBarr.cpp.

                                 {
        return p_chEnd;
}

References p_chEnd.

◆ getChMiddle()

char ProgressBarr::getChMiddle ( ) const

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

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

Definition at line 79 of file ProgressBarr.cpp.

                                    {
        return p_chMiddle;
}

References p_chMiddle.

◆ getChPlein()

char ProgressBarr::getChPlein ( ) const

retourne le caractère de remplissage

Returns: caractère de remplissage

Definition at line 72 of file ProgressBarr.cpp.

                                   {
        return p_chPlein;
}

References p_chPlein.

◆ getMax()

size_t ProgressBarr::getMax ( ) const

retourne la valeur max atteinte par la barre

Returns: valeur max atteinte par la barre

Definition at line 58 of file ProgressBarr.cpp.

                                 {
        return p_max;
}

References p_max.

◆ getSize()

size_t ProgressBarr::getSize ( ) const

retourne la taille maximale de la barre

Returns: taille maximale de la barre

Definition at line 65 of file ProgressBarr.cpp.

                                  {
        return p_size;
}

References p_size.

◆ init()

void ProgressBarr::init	(	size_t	max,
		size_t	size,
		char	chPlein,
		char	chMiddle,
		char	chEnd )

private

Initialisation de la barre de progression en console.

Parameters

max	: valeur maximale atteinte par barre de progression pleine
size	: taille de 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

Definition at line 146 of file ProgressBarr.cpp.

                                                                                      {
        p_buffer = new char[size + 1lu];
        p_size = size;
        p_max = max;
        p_chPlein = chPlein;
        p_chMiddle = chMiddle;
        p_chEnd = chEnd;
        p_old_taille = 0lu;
}

References p_buffer, p_chEnd, p_chMiddle, p_chPlein, p_max, p_old_taille, and p_size.

Referenced by ProgressBarr().

Here is the caller graph for this function:

◆ operator=()

ProgressBarr & ProgressBarr::operator= ( const ProgressBarr & progressBarr )

redéfinition de l'opérateur =

Parameters

progressBarr : barre de chargement à copier

Definition at line 134 of file ProgressBarr.cpp.

                                                                         {
        copy(progressBarr);
        return *this;
}

References copy(), and ProgressBarr().

Here is the call graph for this function:

◆ progress()

void ProgressBarr::progress ( size_t avencement )

fonction qui fait avancer (ou reculer) la barre de chargement

Parameters

avencement : avencement de la barre (plus petit ou égal à max)

Definition at line 40 of file ProgressBarr.cpp.

                                            {
        size_t taille = (avencement*p_size)/p_max;
        if(p_old_taille != taille){
                int pourcent = (avencement*100)/p_max;
                //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(taille);
                std::cerr << "[" << p_buffer << "|" << pourcent << "%]";
                //on met old_taille à jour
                p_old_taille = taille;
        }
}

References clear(), feelbuffer(), p_buffer, p_max, p_old_taille, and p_size.

Referenced by finish().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setChEnd()

void ProgressBarr::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 121 of file ProgressBarr.cpp.

                                     {
        p_chEnd = chEnd;
}

References p_chEnd.

◆ setChMiddle()

void ProgressBarr::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 114 of file ProgressBarr.cpp.

                                           {
        p_chMiddle = chMiddle;
}

References p_chMiddle.

◆ setChPlein()

void ProgressBarr::setChPlein ( char chPlein )

init le caractère de remplissage

Parameters

chPlein : caractère de remplissage

Definition at line 107 of file ProgressBarr.cpp.

                                         {
        p_chPlein = chPlein;
}

References p_chPlein.

◆ setMax()

void ProgressBarr::setMax ( size_t max )

init la valeur max atteinte par la barre

Parameters

max	: valeur max atteinte par la barre

Definition at line 93 of file ProgressBarr.cpp.

                                   {
        p_max = max;
}

References p_max.

◆ setSize()

void ProgressBarr::setSize ( size_t size )

init la taille de la barre

Parameters

size	: taille de la barre de chargement pleine

Definition at line 100 of file ProgressBarr.cpp.

                                     {
        p_size = size;
}

References p_size.

Member Data Documentation

◆ p_buffer

char* ProgressBarr::p_buffer

protected

Drawing buffer.

Definition at line 42 of file ProgressBarr.h.

Referenced by clear(), copy(), feelbuffer(), init(), progress(), ProgressBarr(), and ~ProgressBarr().

◆ p_chEnd

char ProgressBarr::p_chEnd

protected

Character which fills the progress bar.

Definition at line 54 of file ProgressBarr.h.

Referenced by copy(), feelbuffer(), getChEnd(), init(), and setChEnd().

◆ p_chMiddle

char ProgressBarr::p_chMiddle

protected

Character at the end of the progress bar.

Definition at line 52 of file ProgressBarr.h.

Referenced by copy(), feelbuffer(), getChMiddle(), init(), and setChMiddle().

◆ p_chPlein

char ProgressBarr::p_chPlein

protected

Character used to fill the progress bar.

Definition at line 50 of file ProgressBarr.h.

Referenced by copy(), feelbuffer(), getChPlein(), init(), and setChPlein().

◆ p_max

size_t ProgressBarr::p_max

protected

Maximum value to reach to complete charging.

Definition at line 46 of file ProgressBarr.h.

Referenced by copy(), finish(), getMax(), init(), progress(), and setMax().

◆ p_old_taille

size_t ProgressBarr::p_old_taille

protected

Previous size of the progress bar.

Definition at line 48 of file ProgressBarr.h.

Referenced by copy(), init(), and progress().

◆ p_size

size_t ProgressBarr::p_size

protected

Maximum size of the progress bar.

Definition at line 44 of file ProgressBarr.h.

Referenced by clear(), copy(), feelbuffer(), getSize(), init(), progress(), and setSize().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ProgressBarr() [1/2]

◆ ProgressBarr() [2/2]

◆ ~ProgressBarr()

Member Function Documentation

◆ clear()

◆ copy()

◆ feelbuffer()

◆ finish()

◆ getChEnd()

◆ getChMiddle()

◆ getChPlein()

◆ getMax()

◆ getSize()

◆ init()

◆ operator=()

◆ progress()

◆ setChEnd()

◆ setChMiddle()

◆ setChPlein()

◆ setMax()

◆ setSize()

Member Data Documentation

◆ p_buffer

◆ p_chEnd

◆ p_chMiddle

◆ p_chPlein

◆ p_max

◆ p_old_taille

◆ p_size