clanguml::common::generators::progress_indicator_base Class Reference

Detailed Description

Definition at line 28 of file progress_indicator.h.

#include <progress_indicator.h>

Classes
struct	progress_state

Public Member Functions
virtual	~progress_indicator_base ()=default
virtual void	add_progress_bar (const std::string &name, size_t max, indicators::Color color)=0
virtual void	increment (const std::string &name)=0
virtual void	stop ()=0
virtual void	complete (const std::string &name)=0
virtual void	fail (const std::string &name)=0

Protected Attributes
std::map< std::string, progress_state >	progress_bar_index_
std::mutex	progress_bars_mutex_

Constructor & Destructor Documentation

~progress_indicator_base()

virtual clanguml::common::generators::progress_indicator_base::~progress_indicator_base ( )

virtualdefault

Member Function Documentation

add_progress_bar()

virtual void clanguml::common::generators::progress_indicator_base::add_progress_bar ( const std::string &  name, size_t  max, indicators::Color  color  )

pure virtual

Add a new progress bar to the indicator set

Parameters

name	Name (prefix) of the progress bar
max	Total number of steps in the progress bar
color	Color of the progress bar

Implemented in clanguml::common::generators::json_logger_progress_indicator, and clanguml::common::generators::progress_indicator.

complete()

virtual void clanguml::common::generators::progress_indicator_base::complete ( const std::string &  name )

pure virtual

Set specified progress bar as complete.

Parameters

name	Name of the progress bar

Implemented in clanguml::common::generators::json_logger_progress_indicator, and clanguml::common::generators::progress_indicator.

fail()

virtual void clanguml::common::generators::progress_indicator_base::fail ( const std::string &  name )

pure virtual

Set progress bar as failed.

Parameters

name	Name of the progress bar

Implemented in clanguml::common::generators::json_logger_progress_indicator, and clanguml::common::generators::progress_indicator.

increment()

virtual void clanguml::common::generators::progress_indicator_base::increment ( const std::string &  name )

pure virtual

Increment specified progress bar.

Parameters

name	Name of the progress bar

Implemented in clanguml::common::generators::json_logger_progress_indicator, and clanguml::common::generators::progress_indicator.

stop()

virtual void clanguml::common::generators::progress_indicator_base::stop ( )

pure virtual

Stop all the progress bars.

Implemented in clanguml::common::generators::json_logger_progress_indicator, and clanguml::common::generators::progress_indicator.

Member Data Documentation

progress_bar_index_

std::map<std::string, progress_state> clanguml::common::generators::progress_indicator_base::progress_bar_index_

protected

Definition at line 82 of file progress_indicator.h.

progress_bars_mutex_

std::mutex clanguml::common::generators::progress_indicator_base::progress_bars_mutex_

protected

Definition at line 83 of file progress_indicator.h.

---

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

• src/common/generators/progress_indicator.h