ProgressInfo Class Reference

A light-weight base class for Log that allows processes to update, without the need for additional include overheads. More...

#include <ProgressInfo.hpp>

Inheritance diagram for ProgressInfo:

Public Member Functions
virtual bool	addMessage (const char *const message, uint01 log_level=10)=0
virtual bool	addMessage (const LogMessage &message)=0
virtual bool	addMessage (const String &message, uint01 log_level=10)=0
virtual bool	addMessage (const TranslatedString &message, uint01 log_level=10)=0
virtual void	addStream (LogStream *, bool)
virtual void	allowCancel (bool cancel)=0
virtual bool	cancelRequested () const
	ProgressInfo () noexcept
virtual void	removeStream (LogStream *)
virtual void	setCancelRequest (bool)
virtual bool	setProgress (fltp04 percent)=0
virtual	~ProgressInfo ()

Detailed Description

A light-weight base class for Log that allows processes to update, without the need for additional include overheads.

---

Constructor & Destructor Documentation

ProgressInfo()

ProgressInfo ( )

inlinenoexcept

~ProgressInfo()

virtual ~ProgressInfo ( )

inlinevirtual

Member Function Documentation

addMessage() [1/4]

virtual bool addMessage ( const char *const message, uint01 log_level = 10 )

pure virtual

Implemented in Log, and LogManager.

addMessage() [2/4]

virtual bool addMessage ( const LogMessage & message )

pure virtual

Implemented in Log, and LogManager.

addMessage() [3/4]

virtual bool addMessage ( const String & message, uint01 log_level = 10 )

pure virtual

Implemented in Log, and LogManager.

addMessage() [4/4]

virtual bool addMessage ( const TranslatedString & message, uint01 log_level = 10 )

pure virtual

Implemented in Log, and LogManager.

addStream()

virtual void addStream ( LogStream * , bool  )

inlinevirtual

Reimplemented in Log, and LogManager.

allowCancel()

virtual void allowCancel ( bool cancel )

pure virtual

Implemented in Log, and LogManager.

cancelRequested()

virtual bool cancelRequested ( ) const

inlinevirtual

Reimplemented in Log.

removeStream()

virtual void removeStream ( LogStream * )

inlinevirtual

Reimplemented in Log, and LogManager.

setCancelRequest()

virtual void setCancelRequest ( bool )

inlinevirtual

Reimplemented in Log, and LogManager.

setProgress()

virtual bool setProgress ( fltp04 percent )

pure virtual

Implemented in Log, and LogManager.

---

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

• Base/Headers/ProgressInfo.hpp