iv::logs::DownloadLoggerProgress Class Reference

#include <DownloadLoggerProgress.hpp>

Inheritance diagram for iv::logs::DownloadLoggerProgress:

Collaboration diagram for iv::logs::DownloadLoggerProgress:

Public Member Functions
	DownloadLoggerProgress ()=default
AbstractComponentGUI *	build ()
void	updateProgress ()
void	incrElements (uint64_t incrElements, const std::string &extraInfo="")
void	incrElement (const std::string &extraInfo="")
void	setHeader (const std::string &header)
void	setHeaderWithNumberElements (const std::string &header, uint64_t numElements)
void	setMessage (const std::string &txtMsg)
void	setMessageDestroying (const std::string &txtMsg)

Private Member Functions
void	begin () override
void	end () override
bool	isCancelling () override
void	visibleProgress (bool isVisible) override
void	resetProgress () override
void	writeCurrentElements (const std::string &header, uint64_t currentElements, const std::string &extraInfo) override
void	writeMessage (const std::string &header) override
void	writeWithNumElements (const std::string &header, uint64_t currentElements, uint64_t numElements, const std::string &extraInfo) override
void	prvResetCounter (const std::string &header)

Private Attributes
CLabel *	m_message {nullptr}
CProgress *	m_progress {nullptr}
std::atomic_bool	m_isProgressVisible {false}
std::atomic_bool	m_requiresReset {false}
std::mutex	m_mutex
std::optional< std::string >	m_header
std::optional< uint64_t >	m_currentElements
std::optional< uint64_t >	m_numElements
std::optional< std::string >	m_extraInfo
bool	m_withElements

Constructor & Destructor Documentation

DownloadLoggerProgress()

iv::logs::DownloadLoggerProgress::DownloadLoggerProgress ( )

default

Member Function Documentation

begin()

void iv::logs::DownloadLoggerProgress::begin ( )

overrideprivatevirtual

Implements AbstractProgress.

build()

AbstractComponentGUI * iv::logs::DownloadLoggerProgress::build

(

)

end()

void iv::logs::DownloadLoggerProgress::end ( )

overrideprivatevirtual

Implements AbstractProgress.

incrElement()

void AbstractProgress::incrElement ( const std::string & extraInfo = "" )

inherited

incrElements()

void AbstractProgress::incrElements ( uint64_t incrElements, const std::string & extraInfo = "" )

inherited

isCancelling()

bool iv::logs::DownloadLoggerProgress::isCancelling ( )

overrideprivatevirtual

Implements AbstractProgress.

prvResetCounter()

void AbstractProgress::prvResetCounter ( const std::string & header )

privateinherited

resetProgress()

void iv::logs::DownloadLoggerProgress::resetProgress ( )

overrideprivatevirtual

Implements AbstractProgress.

setHeader()

void AbstractProgress::setHeader ( const std::string & header )

inherited

setHeaderWithNumberElements()

void AbstractProgress::setHeaderWithNumberElements ( const std::string & header, uint64_t numElements )

inherited

setMessage()

void AbstractProgress::setMessage ( const std::string & txtMsg )

inherited

setMessageDestroying()

void AbstractProgress::setMessageDestroying ( const std::string & txtMsg )

inherited

updateProgress()

void iv::logs::DownloadLoggerProgress::updateProgress

(

)

visibleProgress()

void iv::logs::DownloadLoggerProgress::visibleProgress ( bool isVisible )

overrideprivatevirtual

Implements AbstractProgress.

writeCurrentElements()

void iv::logs::DownloadLoggerProgress::writeCurrentElements ( const std::string & header, uint64_t currentElements, const std::string & extraInfo )

overrideprivatevirtual

Implements AbstractProgress.

writeMessage()

void iv::logs::DownloadLoggerProgress::writeMessage ( const std::string & header )

overrideprivatevirtual

Implements AbstractProgress.

writeWithNumElements()

void iv::logs::DownloadLoggerProgress::writeWithNumElements ( const std::string & header, uint64_t currentElements, uint64_t numElements, const std::string & extraInfo )

overrideprivatevirtual

Implements AbstractProgress.

Member Data Documentation

m_currentElements

std::optional<uint64_t> iv::logs::DownloadLoggerProgress::m_currentElements

private

m_extraInfo

std::optional<std::string> iv::logs::DownloadLoggerProgress::m_extraInfo

private

m_header

std::optional<std::string> iv::logs::DownloadLoggerProgress::m_header

private

m_isProgressVisible

std::atomic_bool iv::logs::DownloadLoggerProgress::m_isProgressVisible {false}

private

m_message

CLabel* iv::logs::DownloadLoggerProgress::m_message {nullptr}

private

m_mutex

std::mutex iv::logs::DownloadLoggerProgress::m_mutex

private

m_numElements

std::optional<uint64_t> iv::logs::DownloadLoggerProgress::m_numElements

private

m_progress

CProgress* iv::logs::DownloadLoggerProgress::m_progress {nullptr}

private

m_requiresReset

std::atomic_bool iv::logs::DownloadLoggerProgress::m_requiresReset {false}

private

m_withElements

bool AbstractProgress::m_withElements

privateinherited

---

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

• src/logs/DownloadLoggerProgress.hpp
• src/logs/DownloadLoggerProgress.cpp