spdmon::BaseProgress Class Reference

#include <spdmon.hpp>

Inheritance diagram for spdmon::BaseProgress:

Public Types
using	clock_t = std::chrono::steady_clock
using	timepoint_t = clock_t::time_point
using	duration_t = clock_t::duration

Public Member Functions
	BaseProgress (std::string desc="", unsigned int total=0, bool ascii=false)
virtual	~BaseProgress ()=default
void	Restart (std::string desc="", unsigned int total=0)
unsigned int	Count ()
BaseProgress &	operator++ ()
void	operator+= (unsigned int n)
void	SetTotal (unsigned int n)
unsigned int	Size ()
void	FormatBarTo (fmt::memory_buffer &buf, unsigned int width, float frac)
void	Update (unsigned int n=1)
void	RenderProgress (timepoint_t now, unsigned int width, fmt::memory_buffer &buf)
virtual void	ShowProgress (timepoint_t now=clock_t::now())=0

Detailed Description

Definition at line 95 of file spdmon.hpp.

Member Typedef Documentation

clock_t

using spdmon::BaseProgress::clock_t = std::chrono::steady_clock

Definition at line 97 of file spdmon.hpp.

duration_t

using spdmon::BaseProgress::duration_t = clock_t::duration

Definition at line 99 of file spdmon.hpp.

timepoint_t

using spdmon::BaseProgress::timepoint_t = clock_t::time_point

Definition at line 98 of file spdmon.hpp.

Constructor & Destructor Documentation

BaseProgress()

spdmon::BaseProgress::BaseProgress ( std::string desc = "", unsigned int total = 0, bool ascii = false )

inlineexplicit

Definition at line 101 of file spdmon.hpp.

References spdmon::kBarSymsAscii, and spdmon::kBarSymsUnicode.

Referenced by spdmon::LoggerProgress::LoggerProgress(), spdmon::LoggerProgress::LoggerProgress(), operator++(), and spdmon::Progress::Progress().

~BaseProgress()

virtual spdmon::BaseProgress::~BaseProgress ( )

virtualdefault

Member Function Documentation

Count()

unsigned int spdmon::BaseProgress::Count ( )

inline

Definition at line 117 of file spdmon.hpp.

FormatBarTo()

void spdmon::BaseProgress::FormatBarTo ( fmt::memory_buffer & buf, unsigned int width, float frac )

inline

Definition at line 130 of file spdmon.hpp.

Referenced by RenderProgress().

operator++()

BaseProgress & spdmon::BaseProgress::operator++ ( )

inline

Definition at line 119 of file spdmon.hpp.

References BaseProgress(), and Update().

operator+=()

void spdmon::BaseProgress::operator+= ( unsigned int n )

inline

Definition at line 124 of file spdmon.hpp.

References Update().

RenderProgress()

void spdmon::BaseProgress::RenderProgress ( timepoint_t now, unsigned int width, fmt::memory_buffer & buf )

inline

Definition at line 185 of file spdmon.hpp.

References FormatBarTo().

Referenced by spdmon::LoggerProgress::RenderStatusLine(), spdmon::LoggerProgress::ShowProgress(), and spdmon::Progress::ShowProgress().

Restart()

void spdmon::BaseProgress::Restart ( std::string desc = "", unsigned int total = 0 )

inline

Definition at line 110 of file spdmon.hpp.

References ShowProgress().

SetTotal()

void spdmon::BaseProgress::SetTotal ( unsigned int n )

inline

Definition at line 126 of file spdmon.hpp.

ShowProgress()

virtual void spdmon::BaseProgress::ShowProgress ( timepoint_t now = clock_t::now() )

pure virtual

Implemented in spdmon::LoggerProgress, and spdmon::Progress.

Referenced by Restart(), and Update().

Size()

unsigned int spdmon::BaseProgress::Size ( )

inline

Definition at line 128 of file spdmon.hpp.

Update()

void spdmon::BaseProgress::Update ( unsigned int n = 1 )

inline

Definition at line 165 of file spdmon.hpp.

References ShowProgress().

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

---

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

• apps/rux/include/spdmon.hpp