3D Forest
Software for analysis of Lidar data from forest environment.
ProgressCounter Class Reference

#include <ProgressCounter.hpp>

Public Member Functions

 ProgressCounter ()
 
 ~ProgressCounter ()=default
 
void setMaximumStep (uint64_t n=npos, uint64_t interleave=1, double timeout=0.25)
 
uint64_t maximumStep () const
 
void setValueStep (uint64_t n)
 
void addValueStep (uint64_t n)
 
uint64_t valueStep () const
 
void setMaximumSteps (size_t n)
 
void setMaximumSteps (const std::vector< double > &percent)
 
size_t maximumSteps () const
 
void setValueSteps (size_t n)
 
size_t valueSteps () const
 
void startTimer ()
 
bool timedOut ()
 
bool end () const
 
double percent () const
 
int percentToInt () const
 
bool initializing () const
 

Static Public Attributes

static const uint64_t npos = UINT64_MAX
 

Private Member Functions

double percentStep () const
 

Private Attributes

size_t maximumSteps_
 
size_t valueSteps_
 
std::vector< double > percentSteps_
 
uint64_t maximumStep_
 
uint64_t valueStep_
 
double timeout_
 
double timeBegin_
 
double timeNow_
 
uint64_t interleave_
 
uint64_t interleaveCounter_
 

Constructor & Destructor Documentation

◆ ProgressCounter()

ProgressCounter::ProgressCounter ( )

◆ ~ProgressCounter()

ProgressCounter::~ProgressCounter ( )
default

Member Function Documentation

◆ addValueStep()

◆ end()

bool ProgressCounter::end ( ) const
inline

◆ initializing()

bool ProgressCounter::initializing ( ) const
inline

Referenced by ExportFileAction::next().

◆ maximumStep()

◆ maximumSteps()

◆ percent()

double ProgressCounter::percent ( ) const

Referenced by setMaximumSteps().

◆ percentStep()

double ProgressCounter::percentStep ( ) const
private

Referenced by percent().

◆ percentToInt()

int ProgressCounter::percentToInt ( ) const
inline

◆ setMaximumStep()

◆ setMaximumSteps() [1/2]

void ProgressCounter::setMaximumSteps ( const std::vector< double > &  percent)

◆ setMaximumSteps() [2/2]

void ProgressCounter::setMaximumSteps ( size_t  n)

◆ setValueStep()

◆ setValueSteps()

◆ startTimer()

◆ timedOut()

◆ valueStep()

◆ valueSteps()

size_t ProgressCounter::valueSteps ( ) const
inline

Member Data Documentation

◆ interleave_

uint64_t ProgressCounter::interleave_
private

Referenced by setMaximumStep(), and timedOut().

◆ interleaveCounter_

uint64_t ProgressCounter::interleaveCounter_
private

Referenced by setMaximumStep(), and timedOut().

◆ maximumStep_

uint64_t ProgressCounter::maximumStep_
private

◆ maximumSteps_

size_t ProgressCounter::maximumSteps_
private

Referenced by percent(), and setMaximumSteps().

◆ npos

const uint64_t ProgressCounter::npos = UINT64_MAX
static

◆ percentSteps_

std::vector<double> ProgressCounter::percentSteps_
private

Referenced by percent(), and setMaximumSteps().

◆ timeBegin_

double ProgressCounter::timeBegin_
private

◆ timeNow_

double ProgressCounter::timeNow_
private

Referenced by setMaximumStep(), and timedOut().

◆ timeout_

double ProgressCounter::timeout_
private

Referenced by setMaximumStep(), and timedOut().

◆ valueStep_

uint64_t ProgressCounter::valueStep_
private

◆ valueSteps_

size_t ProgressCounter::valueSteps_
private

Referenced by percent(), and setMaximumSteps().


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