Class ProgressTracker

Inherits the following classes: ProgressObserver

Public Functions

Type	Name
	ProgressTracker (ProgressObserver * observer=nullptr, std::string name="", std::source_location location=std::source_location::current(), double range_start=0.0, double range_end=1.0)
	ProgressTracker (const ProgressTracker & other) = delete
	ProgressTracker (ProgressTracker && other)
void	begin_tracking (std::string text, std::source_location location)
bool	is_visible () const
ProgressTracker &	operator= (const ProgressTracker & other) = delete
ProgressTracker &	operator= (ProgressTracker && other) = delete
double	proportion () const
void	report_parallel_progress (double proportion)
void	set_proportion (double proportion)
void	set_visible (bool v)
ProgressTracker	subtracker (double start, double end, std::string name="", std::source_location location=std::source_location::current(), std::optional< bool > visible=std::nullopt)
virtual void	text_update (const std::string & text, int depth=0) override
virtual	~ProgressTracker ()

Public Functions inherited from ProgressObserver

See ProgressObserver

Type	Name
ProgressTracker *	child ()
virtual	~ProgressObserver ()

Protected Functions

Type	Name
virtual void	update_progress (double progress) override

Protected Functions inherited from ProgressObserver

See ProgressObserver

Type	Name
	ProgressObserver ()
virtual void	text_update (const std::string & text, int depth=0) = 0
virtual void	update_progress (double progress) = 0

Public Functions Documentation

function ProgressTracker [1/3]

explicit ProgressTracker::ProgressTracker (
    ProgressObserver * observer=nullptr,
    std::string name="",
    std::source_location location=std::source_location::current(),
    double range_start=0.0,
    double range_end=1.0
)

function ProgressTracker [2/3]

ProgressTracker::ProgressTracker (
    const ProgressTracker & other
) = delete

function ProgressTracker [3/3]

ProgressTracker::ProgressTracker (
    ProgressTracker && other
)

function begin_tracking

void ProgressTracker::begin_tracking (
    std::string text,
    std::source_location location
)

function is_visible

inline bool ProgressTracker::is_visible () const

function operator=

ProgressTracker & ProgressTracker::operator= (
    const ProgressTracker & other
) = delete

function operator=

ProgressTracker & ProgressTracker::operator= (
    ProgressTracker && other
) = delete

function proportion

inline double ProgressTracker::proportion () const

function report_parallel_progress

void ProgressTracker::report_parallel_progress (
    double proportion
)

function set_proportion

void ProgressTracker::set_proportion (
    double proportion
)

function set_visible

inline void ProgressTracker::set_visible (
    bool v
)

function subtracker

ProgressTracker ProgressTracker::subtracker (
    double start,
    double end,
    std::string name="",
    std::source_location location=std::source_location::current(),
    std::optional< bool > visible=std::nullopt
)

function text_update

virtual void ProgressTracker::text_update (
    const std::string & text,
    int depth=0
) override

Implements ProgressObserver::text_update

function ~ProgressTracker

virtual ProgressTracker::~ProgressTracker ()

Protected Functions Documentation

function update_progress

virtual void ProgressTracker::update_progress (
    double progress
) override

Implements ProgressObserver::update_progress

The documentation for this class was generated from the following file /home/runner/work/Blaze/Blaze/src/lib/utilities/progress_tracker.hpp