spdmon::Progress Class Reference

#include <spdmon.hpp>

Inheritance diagram for spdmon::Progress:

Collaboration diagram for spdmon::Progress:

Public Member Functions
	Progress (std::string desc="", unsigned int total=0, bool ascii=false, FILE *file=stderr, unsigned int width=0)
	~Progress () override=default
	Progress (const Progress &other)=delete
Progress &	operator= (const Progress &other)=delete
	Progress (Progress &&other) noexcept=delete
Progress &	operator= (Progress &&other) noexcept=delete
void	UpdateTermWidth ()
void	ShowProgress (timepoint_t now=clock_t::now()) final
Public Member Functions inherited from spdmon::BaseProgress
	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)

Public Attributes
const std::string	kTermMoveUp = "\x1B[A"

Additional Inherited Members
Public Types inherited from spdmon::BaseProgress
using	clock_t = std::chrono::steady_clock
using	timepoint_t = clock_t::time_point
using	duration_t = clock_t::duration

Detailed Description

Definition at line 257 of file spdmon.hpp.

Constructor & Destructor Documentation

Progress() [1/3]

spdmon::Progress::Progress ( std::string desc = "", unsigned int total = 0, bool ascii = false, FILE * file = stderr, unsigned int width = 0 )

inlineexplicit

Definition at line 259 of file spdmon.hpp.

References spdmon::BaseProgress::BaseProgress(), and UpdateTermWidth().

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

~Progress()

spdmon::Progress::~Progress ( )

overridedefault

Progress() [2/3]

spdmon::Progress::Progress ( const Progress & other )

delete

Progress() [3/3]

spdmon::Progress::Progress ( Progress && other )

deletenoexcept

Member Function Documentation

operator=() [1/2]

Progress & spdmon::Progress::operator= ( const Progress & other )

delete

References Progress().

operator=() [2/2]

Progress & spdmon::Progress::operator= ( Progress && other )

deletenoexcept

References Progress(), and SPDMON_DECLARE_NON_MOVEABLE.

ShowProgress()

void spdmon::Progress::ShowProgress ( timepoint_t now = clock_t::now() )

inlinefinalvirtual

Implements spdmon::BaseProgress.

Definition at line 283 of file spdmon.hpp.

References kTermMoveUp, and spdmon::BaseProgress::RenderProgress().

UpdateTermWidth()

void spdmon::Progress::UpdateTermWidth ( )

inline

Definition at line 275 of file spdmon.hpp.

References UpdateTermWidth().

Referenced by Progress(), and UpdateTermWidth().

Member Data Documentation

kTermMoveUp

const std::string spdmon::Progress::kTermMoveUp = "\x1B[A"

Definition at line 293 of file spdmon.hpp.

Referenced by ShowProgress().

---

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

• apps/rux/include/spdmon.hpp