MyraMath
Public Member Functions | List of all members
myra::ProgressMeter Class Reference

Interface for measuring progress via callbacks. Wraps an underlying polymorphic ProgressMeterBase. More...

#include <ProgressMeter.h>

Public Member Functions

 ProgressMeter ()
 Default constructor, initializes with a NullProgressMeter.
 
 ProgressMeter (const ProgressMeterBase &that)
 Clone constructor (deep).
 
 ProgressMeter (const ProgressMeter &that)
 Copy constructor (deep).
 
void swap (ProgressMeter &that)
 Member swap.
 
ProgressMeteroperator= (ProgressMeter that)
 Assignment operator, copy and swap idiom.
 
 ~ProgressMeter ()
 Frees internal resources.
 
void begin (const std::string &name, uint64_t total)
 Called when a lengthy operation is started.
 
void increment (uint64_t delta)
 Called repeatedly between begin() and end(), to regularly increment progress.
 
void end ()
 Called when a lengthy operation is finished.
 
bool kill ()
 Regularly polled while a JobGraph execute()'s, execution will halt if kill()==true.
 

Detailed Description

Interface for measuring progress via callbacks. Wraps an underlying polymorphic ProgressMeterBase.


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