Lightweight::NullProgressTask Class Reference

A ProgressTask that reports nothing and is never cancelled; used where a host passes none. More...

#include <ProgressTask.hpp>

Inheritance diagram for Lightweight::NullProgressTask:

Public Member Functions
std::unique_ptr< ProgressTask >	BeginSubTask (std::string_view, std::uint64_t) override
void	SetTotal (std::uint64_t) override
	Does nothing.
void	Advance (std::uint64_t, std::string_view) override
	Does nothing.
void	Log (LogLevel, std::string_view) override
	Does nothing.
bool	IsCancellationRequested () const override
void	Fail (std::string_view) override
	Does nothing.
Public Member Functions inherited from Lightweight::ProgressTask
	ProgressTask (ProgressTask const &)=delete
	ProgressTask (ProgressTask &&)=delete
ProgressTask &	operator= (ProgressTask const &)=delete
ProgressTask &	operator= (ProgressTask &&)=delete
virtual	~ProgressTask ()=default
	Marks the task finished.

Additional Inherited Members
Public Types inherited from Lightweight::ProgressTask
enum class	LogLevel : std::uint8_t { Info , Warning , Error }
	Severity of a message reported against a task. More...

Detailed Description

A ProgressTask that reports nothing and is never cancelled; used where a host passes none.

Definition at line 67 of file ProgressTask.hpp.

Member Function Documentation

BeginSubTask()

std::unique_ptr< ProgressTask > Lightweight::NullProgressTask::BeginSubTask ( std::string_view  , std::uint64_t    )

inlineoverridevirtual

Returns

Another NullProgressTask.

Implements Lightweight::ProgressTask.

Definition at line 71 of file ProgressTask.hpp.

SetTotal()

void Lightweight::NullProgressTask::SetTotal ( std::uint64_t  )

inlineoverridevirtual

Does nothing.

Implements Lightweight::ProgressTask.

Definition at line 77 of file ProgressTask.hpp.

Advance()

void Lightweight::NullProgressTask::Advance ( std::uint64_t  , std::string_view    )

inlineoverridevirtual

Does nothing.

Implements Lightweight::ProgressTask.

Definition at line 80 of file ProgressTask.hpp.

Log()

void Lightweight::NullProgressTask::Log ( LogLevel  , std::string_view    )

inlineoverridevirtual

Does nothing.

Implements Lightweight::ProgressTask.

Definition at line 83 of file ProgressTask.hpp.

IsCancellationRequested()

bool Lightweight::NullProgressTask::IsCancellationRequested ( ) const

inlineoverridevirtual

Returns

Always false.

Implements Lightweight::ProgressTask.

Definition at line 86 of file ProgressTask.hpp.

Fail()

void Lightweight::NullProgressTask::Fail ( std::string_view  )

inlineoverridevirtual

Does nothing.

Implements Lightweight::ProgressTask.

Definition at line 92 of file ProgressTask.hpp.

---

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

• Lightweight/ProgressTask.hpp