clanguml::common::generators::json_logger_progress_indicator Class Reference

Detailed Description

Definition at line 86 of file progress_indicator.h.

#include <progress_indicator.h>

Public Member Functions
	json_logger_progress_indicator ()=default
	~json_logger_progress_indicator () override=default
void	add_progress_bar (const std::string &name, size_t max, indicators::Color color) override
void	increment (const std::string &name) override
void	stop () override
void	complete (const std::string &name) override
void	fail (const std::string &name) override
Public Member Functions inherited from clanguml::common::generators::progress_indicator_base
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

Additional Inherited Members
Protected Attributes inherited from clanguml::common::generators::progress_indicator_base
std::map< std::string, progress_state >	progress_bar_index_
std::mutex	progress_bars_mutex_

Constructor & Destructor Documentation

json_logger_progress_indicator()

clanguml::common::generators::json_logger_progress_indicator::json_logger_progress_indicator ( )

default

~json_logger_progress_indicator()

clanguml::common::generators::json_logger_progress_indicator::~json_logger_progress_indicator ( )

overridedefault

Member Function Documentation

add_progress_bar()

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

overridevirtual

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

Implements clanguml::common::generators::progress_indicator_base.

Definition at line 37 of file progress_indicator.cc.

{
    inja::json j;
    j["diagram_name"] = name;
    j["max"] = max;
    j["progress"] = 0;
    j["status"] = "started";
 
    progress_bars_mutex_.lock();
 
    progress_bar_index_.emplace(name, progress_state{0, 0, max});
 
    progress_bars_mutex_.unlock();
 
    spdlog::get("json-progress-logger")
        ->log(spdlog::level::info, "{}", j.dump());
}

complete()

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

overridevirtual

Set specified progress bar as complete.

Parameters

name	Name of the progress bar

Implements clanguml::common::generators::progress_indicator_base.

Definition at line 149 of file progress_indicator.cc.

{
    inja::json j;
    j["diagram_name"] = name;
 
    progress_bars_mutex_.lock();
 
    if (progress_bar_index_.count(name) == 0) {
        progress_bars_mutex_.unlock();
        return;
    }
 
    auto &p = progress_bar_index_.at(name);
 
    p.progress = p.max;
 
    j["progress"] = p.progress;
    j["max"] = p.max;
    j["status"] = "completed";
 
    progress_bars_mutex_.unlock();
 
    spdlog::get("json-progress-logger")
        ->log(spdlog::level::info, "{}", j.dump());
}

fail()

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

overridevirtual

Set progress bar as failed.

Parameters

name	Name of the progress bar

Implements clanguml::common::generators::progress_indicator_base.

Definition at line 206 of file progress_indicator.cc.

{
    inja::json j;
    j["diagram_name"] = name;
 
    progress_bars_mutex_.lock();
 
    if (progress_bar_index_.count(name) == 0) {
        progress_bars_mutex_.unlock();
        return;
    }
    auto &p = progress_bar_index_.at(name);
 
    j["progress"] = p.progress;
    j["max"] = p.max;
    j["status"] = "failed";
 
    progress_bars_mutex_.unlock();
 
    spdlog::get("json-progress-logger")
        ->log(spdlog::level::err, "{}", j.dump());
}

increment()

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

overridevirtual

Increment specified progress bar.

Parameters

name	Name of the progress bar

Implements clanguml::common::generators::progress_indicator_base.

Definition at line 89 of file progress_indicator.cc.

{
    inja::json j;
    j["diagram_name"] = name;
 
    progress_bars_mutex_.lock();
 
    if (progress_bar_index_.count(name) == 0) {
        progress_bars_mutex_.unlock();
        return;
    }
 
    auto &p = progress_bar_index_.at(name);
 
    j["progress"] = p.progress;
    j["max"] = p.max;
    j["status"] = "ongoing";
 
    p.progress++;
 
    progress_bars_mutex_.unlock();
 
    spdlog::get("json-progress-logger")
        ->log(spdlog::level::info, "{}", j.dump());
}

stop()

void clanguml::common::generators::json_logger_progress_indicator::stop ( )

inlineoverridevirtual

Stop all the progress bars.

Implements clanguml::common::generators::progress_indicator_base.

Definition at line 97 of file progress_indicator.h.

{ }

---

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

• src/common/generators/progress_indicator.h
• src/common/generators/progress_indicator.cc