TPIE

2362a60
tpie::dummy_fraction_progress Struct Reference

A fractional progress indicator that is conceptually compatible with tpie::fractional_progress. More...

#include <tpie/dummy_progress.h>

Public Member Functions

 dummy_fraction_progress (tpie::progress_indicator_base *)
 Dummy constructor that does nothing. More...
 
 dummy_fraction_progress (dummy_progress_indicator *)
 Dummy constructor that does nothing. More...
 
dummy_fraction_progressid ()
 Return this progress indicator's unique id. More...
 
template<typename T >
dummy_fraction_progressoperator<< (const T &)
 
void init (stream_size_type range=0)
 Initialize progress indicator. More...
 
void done ()
 Advance the indicator to the end. More...
 

Detailed Description

A fractional progress indicator that is conceptually compatible with tpie::fractional_progress.

Definition at line 41 of file dummy_progress.h.

Constructor & Destructor Documentation

tpie::dummy_fraction_progress::dummy_fraction_progress ( tpie::progress_indicator_base )
inline

Dummy constructor that does nothing.

Definition at line 45 of file dummy_progress.h.

45  {
46  // Do nothing.
47  }
tpie::dummy_fraction_progress::dummy_fraction_progress ( dummy_progress_indicator )
inline

Dummy constructor that does nothing.

Definition at line 52 of file dummy_progress.h.

52  {
53  // Do nothing.
54  }

Member Function Documentation

void tpie::dummy_fraction_progress::done ( )
inline

Advance the indicator to the end.

Definition at line 74 of file dummy_progress.h.

74  {
75  }
dummy_fraction_progress& tpie::dummy_fraction_progress::id ( )
inline

Return this progress indicator's unique id.

Definition at line 57 of file dummy_progress.h.

57  {
58  return *this;
59  }
void tpie::dummy_fraction_progress::init ( stream_size_type  range = 0)
inline

Initialize progress indicator.

Parameters
rangeThe number of times step() is going to be called.

Definition at line 68 of file dummy_progress.h.

References tpie::unused().

68  {
69  unused(range);
70  }
void unused(const T &x)
Declare that a variable is unused on purpose.
Definition: util.h:42

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