Bifrost SDK
Bifrost SDK documentation
Amino::TaskProgressNotifier Class Reference

RAII-style progress notifier helper. More...

#include <TaskObserver.h>

Public Member Functions

template<typename TaskNotifier >
 TaskProgressNotifier (TaskNotifier &notifier, StringLiteral title, unsigned denum)
 Constructor. More...
 
void notify (unsigned n=1)
 Notify the observer of the progress of the task. More...
 

Detailed Description

RAII-style progress notifier helper.

Takes the notifier, a title and a denumerator corresponding to the total number of steps in the subtask reporting progress. The constructor will do the initial notification (indicating new subtask started (with zero step completed)). Then "notify" function should be called to report progress.

Definition at line 495 of file TaskObserver.h.

Constructor & Destructor Documentation

◆ TaskProgressNotifier()

template<typename TaskNotifier >
Amino::TaskProgressNotifier::TaskProgressNotifier ( TaskNotifier notifier,
StringLiteral  title,
unsigned  denum 
)
inline

Constructor.

Definition at line 499 of file TaskObserver.h.

Member Function Documentation

◆ notify()

void Amino::TaskProgressNotifier::notify ( unsigned  n = 1)
inline

Notify the observer of the progress of the task.

Definition at line 509 of file TaskObserver.h.