PMultiThreadProgress Class Reference

Deal with Progress bar in mutlithread mode. More...

#include <PMultiThreadProgress.h>

Public Member Functions
size_t	addProgressBar (const PString &name, int progressMax=1)
	Add a progress line.
void	incrementProgress (size_t index)
	Increment the progress of the progress bar at index.
bool	isFinished () const
	Say if the PMultiThreadProgress is finished.
PMultiThreadProgress &	operator= (const PMultiThreadProgress &other)
	Definition of equal operator of PMultiThreadProgress.
	PMultiThreadProgress (const PMultiThreadProgress &other)
	Copy constructor of PMultiThreadProgress.
	PMultiThreadProgress (size_t nbExpectedProgressBar=1lu)
	Default constructor of PMultiThreadProgress.
void	print ()
	Print the multithread progress bar.
void	printSummary () const
	Print a summary of all the progress bars.
void	setError (size_t index)
	Mark the progress bar at index finished with an error.
void	setNbExpectedProgressBar (size_t nbExpectedProgressBar)
	Set the number of expected progress bars in the PMultiThreadProgress.
virtual	~PMultiThreadProgress ()
	Destructor of PMultiThreadProgress.

Protected Member Functions
void	copyPMultiThreadProgress (const PMultiThreadProgress &other)
	Copy function of PMultiThreadProgress.

Private Member Functions
void	eraseProgressBar (size_t nbColTerminal)
	Erase all progress bars.
size_t	getNbColTerminal () const
	Get the number of columns in the current terminal.
void	initialisationPMultiThreadProgress (size_t nbExpectedProgressBar)
	Initialisation function of the class PMultiThreadProgress.
bool	isModified ()
	Check if the PMultiThreadProgress has been modified.
void	printAllFinshedProgressBar ()
	Print all finished progress bars.
void	printProgressBar (size_t nbColTerminal)
	Print all progress bars.

Private Attributes
size_t	p_alreadyPrintedLine
	Nunmber of already printed line.
std::mutex	p_currentMutex
	Mutex of the class to avoid conflict manipulation between threads.
size_t	p_nbExpectedProgressBar
	Number of expected progress bars.
size_t	p_previousNbProgressBar
	Previous number of progress bars.
VecProgressElement	p_vecProgressElement
	Vector of pair (progress, between 0 and 100) and name of progress.

Detailed Description

Deal with Progress bar in mutlithread mode.

Definition at line 36 of file PMultiThreadProgress.h.

Constructor & Destructor Documentation

PMultiThreadProgress() [1/2]

PMultiThreadProgress::PMultiThreadProgress

(

size_t

nbExpectedProgressBar = 1lu

)

Default constructor of PMultiThreadProgress.

Parameters

nbExpectedProgressBar

: number of expected progress bars

Definition at line 29 of file PMultiThreadProgress.cpp.

                                                                      {
        initialisationPMultiThreadProgress(nbExpectedProgressBar);
}

References initialisationPMultiThreadProgress().

Referenced by copyPMultiThreadProgress(), operator=(), and PMultiThreadProgress().

Here is the call graph for this function:

Here is the caller graph for this function:

PMultiThreadProgress() [2/2]

PMultiThreadProgress::PMultiThreadProgress

(

const PMultiThreadProgress &

other

)

Copy constructor of PMultiThreadProgress.

Parameters

other

: class to copy

Definition at line 36 of file PMultiThreadProgress.cpp.

                                                                            {
        copyPMultiThreadProgress(other);
}

References copyPMultiThreadProgress(), and PMultiThreadProgress().

Here is the call graph for this function:

~PMultiThreadProgress()

PMultiThreadProgress::~PMultiThreadProgress ( )

virtual

Destructor of PMultiThreadProgress.

Definition at line 41 of file PMultiThreadProgress.cpp.

                                           {
        
}

Member Function Documentation

addProgressBar()

size_t PMultiThreadProgress::addProgressBar	(	const PString &	name,
		int	progressMax = 1 )

Add a progress line.

Parameters

name	: name of the progress line
progressMax	: maximum of progression bar

Returns

index of the created progress line

Definition at line 66 of file PMultiThreadProgress.cpp.

                                                                                {
        std::lock_guard<std::mutex> guard(p_currentMutex);
        size_t index = p_vecProgressElement.size();
        ProgressElement el;
        el.progress = 0;
        el.prevProgress = -1;
        el.progressMax = progressMax;
        el.name = name;
        el.isEndError = false;
        p_vecProgressElement.push_back(el);
        return index;
}

References ProgressElement::isEndError, ProgressElement::name, p_currentMutex, p_vecProgressElement, ProgressElement::prevProgress, ProgressElement::progress, and ProgressElement::progressMax.

Referenced by phoenix_program_callVecProgress().

Here is the caller graph for this function:

copyPMultiThreadProgress()

void PMultiThreadProgress::copyPMultiThreadProgress ( const PMultiThreadProgress & other )

protected

Copy function of PMultiThreadProgress.

Parameters

other

: class to copy

Definition at line 127 of file PMultiThreadProgress.cpp.

                                                                                     {
        p_vecProgressElement = other.p_vecProgressElement;
        p_alreadyPrintedLine = other.p_alreadyPrintedLine;
        p_nbExpectedProgressBar = other.p_nbExpectedProgressBar;
}

References p_alreadyPrintedLine, p_nbExpectedProgressBar, p_vecProgressElement, and PMultiThreadProgress().

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

Here is the call graph for this function:

Here is the caller graph for this function:

eraseProgressBar()

void PMultiThreadProgress::eraseProgressBar ( size_t nbColTerminal )

private

Erase all progress bars.

Parameters

nbColTerminal

: number of columns in the current terminal

Definition at line 161 of file PMultiThreadProgress.cpp.

                                                               {
        if(p_previousNbProgressBar == 0lu){return;}
        //Advances method but can't write anyting
        std::cerr << "\33[2K\r";        //Remove a line where the cursor is
        for(size_t i(p_alreadyPrintedLine + 1u); i < p_previousNbProgressBar; ++i){
                std::cerr << "\033[A";          //Go to one line up
                std::cerr << "\33[2K\r";        //Remove a line where the cursor is
        }
}

References p_alreadyPrintedLine, and p_previousNbProgressBar.

Referenced by print().

Here is the caller graph for this function:

getNbColTerminal()

size_t PMultiThreadProgress::getNbColTerminal ( ) const

private

Get the number of columns in the current terminal.

Returns

number of columns in the current terminal

Definition at line 227 of file PMultiThreadProgress.cpp.

                                                   {
        struct winsize w;
        ioctl(0, TIOCGWINSZ, &w);
        return w.ws_col;
}

Referenced by print().

Here is the caller graph for this function:

incrementProgress()

void PMultiThreadProgress::incrementProgress

(

size_t

index

)

Increment the progress of the progress bar at index.

Parameters

index

: index of the progress bar to be incremented

Definition at line 82 of file PMultiThreadProgress.cpp.

                                                        {
        p_vecProgressElement[index].progress++;
}

References p_vecProgressElement.

Referenced by phoenix_program_callVecProgress().

Here is the caller graph for this function:

initialisationPMultiThreadProgress()

void PMultiThreadProgress::initialisationPMultiThreadProgress ( size_t nbExpectedProgressBar )

private

Initialisation function of the class PMultiThreadProgress.

Parameters

nbExpectedProgressBar

: number of expected progress bars

Definition at line 136 of file PMultiThreadProgress.cpp.

                                                                                         {
        p_alreadyPrintedLine = 0lu;
        p_previousNbProgressBar = 0lu;
        p_nbExpectedProgressBar = nbExpectedProgressBar;
        p_vecProgressElement.reserve(nbExpectedProgressBar);
}

References p_alreadyPrintedLine, p_nbExpectedProgressBar, p_previousNbProgressBar, and p_vecProgressElement.

Referenced by PMultiThreadProgress().

Here is the caller graph for this function:

isFinished()

bool PMultiThreadProgress::isFinished

(

)

const

Say if the PMultiThreadProgress is finished.

Returns

true if the PMultiThreadProgress is finished, false otherwise

Definition at line 96 of file PMultiThreadProgress.cpp.

                                           {
        return p_alreadyPrintedLine == p_vecProgressElement.size() && p_vecProgressElement.size() >= p_nbExpectedProgressBar;
}

References p_alreadyPrintedLine, p_nbExpectedProgressBar, and p_vecProgressElement.

Referenced by phoenix_print_parallel_progress().

Here is the caller graph for this function:

isModified()

bool PMultiThreadProgress::isModified ( )

private

Check if the PMultiThreadProgress has been modified.

Returns

true if the PMultiThreadProgress has been modified, false otherwise

Definition at line 146 of file PMultiThreadProgress.cpp.

                                     {
        std::lock_guard<std::mutex> guard(p_currentMutex);
        bool isModif(false);
        size_t i(p_alreadyPrintedLine);
        while(!isModif && i < p_vecProgressElement.size()){
                ProgressElement & el = p_vecProgressElement[i];
                isModif = el.progress != el.prevProgress || el.isEndError;
                ++i;
        }
        return isModif;
}

References ProgressElement::isEndError, p_alreadyPrintedLine, p_currentMutex, p_vecProgressElement, ProgressElement::prevProgress, and ProgressElement::progress.

Referenced by print().

Here is the caller graph for this function:

operator=()

PMultiThreadProgress & PMultiThreadProgress::operator=

(

const PMultiThreadProgress &

other

)

Definition of equal operator of PMultiThreadProgress.

Parameters

other

: class to copy

Returns

copied class

Definition at line 49 of file PMultiThreadProgress.cpp.

                                                                                          {
        copyPMultiThreadProgress(other);
        return *this;
}

References copyPMultiThreadProgress(), and PMultiThreadProgress().

Here is the call graph for this function:

print()

void PMultiThreadProgress::print

(

)

Print the multithread progress bar.

Definition at line 101 of file PMultiThreadProgress.cpp.

                                {
        if(!isModified()){return;}    //No need to print
        size_t nbColTerminal = getNbColTerminal();
        //Clear all the progress bars on screen
        eraseProgressBar(nbColTerminal);
        //Check if we can print first finshed lines definitely
        printAllFinshedProgressBar();
        //Update the rest of the progress bars to print
        printProgressBar(nbColTerminal);
        //We save the previous number of progress bars, in case we print some and add other later
        p_previousNbProgressBar = p_vecProgressElement.size();
}

References eraseProgressBar(), getNbColTerminal(), isModified(), p_previousNbProgressBar, p_vecProgressElement, printAllFinshedProgressBar(), and printProgressBar().

Referenced by phoenix_print_parallel_progress().

Here is the call graph for this function:

Here is the caller graph for this function:

printAllFinshedProgressBar()

void PMultiThreadProgress::printAllFinshedProgressBar ( )

private

Print all finished progress bars.

Definition at line 204 of file PMultiThreadProgress.cpp.

                                                     {
        std::lock_guard<std::mutex> guard(p_currentMutex);
        size_t i(p_alreadyPrintedLine);
        while(i < p_vecProgressElement.size()){
                ProgressElement & el = p_vecProgressElement[i];
                if(el.progress >= el.progressMax || el.isEndError){        //This is a finished progress bar
                        std::cout << el.name << " : ";
                        if(el.isEndError){
                                std::cout << "\033[31mError\033[0m" << std::endl;
                        }else{
                                std::cout << "\033[32mDone\033[0m" << std::endl;
                        }
                        ++p_alreadyPrintedLine;
                }else{
                        break;
                }
                ++i;
        }
}

References ProgressElement::isEndError, ProgressElement::name, p_alreadyPrintedLine, p_currentMutex, p_vecProgressElement, ProgressElement::progress, and ProgressElement::progressMax.

Referenced by print().

Here is the caller graph for this function:

printProgressBar()

void PMultiThreadProgress::printProgressBar ( size_t nbColTerminal )

private

Print all progress bars.

Parameters

nbColTerminal

: number of columns in the current terminal

Definition at line 174 of file PMultiThreadProgress.cpp.

                                                               {
        for(size_t i(p_alreadyPrintedLine); i < p_vecProgressElement.size(); ++i){
                ProgressElement & el = p_vecProgressElement[i];
                std::cerr << el.name << " : ";
                if(el.progress >= el.progressMax || el.isEndError){        //This is a finished progress bar but not finaly drawed
                        if(el.isEndError){
                                std::cerr << "\033[31mError\033[0m";
                                for(size_t j(el.name.size() + 8lu); j < nbColTerminal; ++j){
                                        std::cerr << " ";
                                }
                        }else{
                                std::cerr << "\033[32mDone\033[0m";
                                for(size_t j(el.name.size() + 7lu); j < nbColTerminal; ++j){
                                        std::cerr << " ";
                                }
                        }
                }else{
                        int avencement = (100*el.progress)/el.progressMax;
                        std::stringstream strAvencement;
                        strAvencement << avencement;
                        std::cerr << avencement << "%";
                        for(size_t j(el.name.size() + 4lu + strAvencement.str().size()); j < nbColTerminal; ++j){
                                std::cerr << " ";
                        }
                        el.prevProgress = el.progress;      //Update previous progress
                }
        }
}

References ProgressElement::isEndError, ProgressElement::name, p_alreadyPrintedLine, p_vecProgressElement, ProgressElement::prevProgress, ProgressElement::progress, and ProgressElement::progressMax.

Referenced by print().

Here is the caller graph for this function:

printSummary()

void PMultiThreadProgress::printSummary

(

)

const

Print a summary of all the progress bars.

Definition at line 115 of file PMultiThreadProgress.cpp.

                                             {
        size_t nbFail(0lu);
        for(VecProgressElement::const_iterator it(p_vecProgressElement.begin()); it != p_vecProgressElement.end(); ++it){
                nbFail += it->isEndError;
        }
        size_t nbSuccess(p_vecProgressElement.size() - nbFail);
        std::cout << "PMultiThreadProgress : " << p_vecProgressElement.size() << " computations, " << nbSuccess << " success, " << nbFail << " fail" << std::endl;
}

References p_vecProgressElement.

Referenced by phoenix_print_parallel_progress().

Here is the caller graph for this function:

setError()

void PMultiThreadProgress::setError

(

size_t

index

)

Mark the progress bar at index finished with an error.

Parameters

index

: index of the progress bar to be modified

Definition at line 89 of file PMultiThreadProgress.cpp.

                                               {
        p_vecProgressElement[index].isEndError = true;
}

References p_vecProgressElement.

setNbExpectedProgressBar()

void PMultiThreadProgress::setNbExpectedProgressBar

(

size_t

nbExpectedProgressBar

)

Set the number of expected progress bars in the PMultiThreadProgress.

Parameters

nbExpectedProgressBar

: number of expected progress bars

Definition at line 57 of file PMultiThreadProgress.cpp.

                                                                               {
        p_nbExpectedProgressBar = nbExpectedProgressBar;
}

References p_nbExpectedProgressBar.

Member Data Documentation

p_alreadyPrintedLine

size_t PMultiThreadProgress::p_alreadyPrintedLine

private

Nunmber of already printed line.

Definition at line 65 of file PMultiThreadProgress.h.

Referenced by copyPMultiThreadProgress(), eraseProgressBar(), initialisationPMultiThreadProgress(), isFinished(), isModified(), printAllFinshedProgressBar(), and printProgressBar().

p_currentMutex

std::mutex PMultiThreadProgress::p_currentMutex

private

Mutex of the class to avoid conflict manipulation between threads.

Definition at line 69 of file PMultiThreadProgress.h.

Referenced by addProgressBar(), isModified(), and printAllFinshedProgressBar().

p_nbExpectedProgressBar

size_t PMultiThreadProgress::p_nbExpectedProgressBar

private

Number of expected progress bars.

Definition at line 73 of file PMultiThreadProgress.h.

Referenced by copyPMultiThreadProgress(), initialisationPMultiThreadProgress(), isFinished(), and setNbExpectedProgressBar().

p_previousNbProgressBar

size_t PMultiThreadProgress::p_previousNbProgressBar

private

Previous number of progress bars.

Definition at line 71 of file PMultiThreadProgress.h.

Referenced by eraseProgressBar(), initialisationPMultiThreadProgress(), and print().

p_vecProgressElement

VecProgressElement PMultiThreadProgress::p_vecProgressElement

private

Vector of pair (progress, between 0 and 100) and name of progress.

Definition at line 67 of file PMultiThreadProgress.h.

Referenced by addProgressBar(), copyPMultiThreadProgress(), incrementProgress(), initialisationPMultiThreadProgress(), isFinished(), isModified(), print(), printAllFinshedProgressBar(), printProgressBar(), printSummary(), and setError().

---

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

• /builds/CTA-LAPP/PHOENIX_LIBS2/system/PhoenixThread/src/PMultiThreadProgress.h
• /builds/CTA-LAPP/PHOENIX_LIBS2/system/PhoenixThread/src/PMultiThreadProgress.cpp