ProgressData Class Reference

Maintain min, max, and counter value for progress counting. More...

#include <ProgressCounter.h>

Inheritance diagram for ProgressData:

List of all members.

Public Member Functions
	ProgressData (int max_r=0)
	ProgressData (int min_r, int max_r)
	ProgressData (int min_r, int max_r, int val_r)
	ProgressData (const ProgressData &rhs)
ProgressData &	operator= (const ProgressData &rhs)
virtual	~ProgressData ()
virtual ProgressData &	min (int min_r)
virtual ProgressData &	max (int max_r)
virtual ProgressData &	range (int min_r, int max_r)
ProgressData &	range (int max_r)
virtual ProgressData &	set (int val_r)
ProgressData &	incr (int val_r=1)
ProgressData &	decr (int val_r=1)
ProgressData &	toMin ()
ProgressData &	toMax ()
virtual ProgressData &	init (int min_r, int max_r, int val_r)
ProgressData &	init (int min_r, int max_r)
ProgressData &	init (int max_r)
int	min () const
int	max () const
int	val () const
Private Attributes
int	_min
int	_max
int	_val
Friends
std::ostream &	operator<< (std::ostream &str, const ProgressData &obj)

---

Detailed Description

Maintain min, max, and counter value for progress counting.

This is what the sender of progress data maintains to send them via a callback. All actualy value manipulating methods are virtual. This is to ProgressCounter to keep track of changing values.

---

Constructor & Destructor Documentation

ProgressData::ProgressData (  int  max_r = 0  )  [inline]

Constructor. Sets min/val to 0.

ProgressData::ProgressData (  int  min_r, int  max_r )  [inline]

Constructor. Sets val to min_r.

ProgressData::ProgressData (  int  min_r, int  max_r, int  val_r )  [inline]

Constructor.

ProgressData::ProgressData (  const ProgressData &  rhs  )  [inline]

Copy Constructor.

virtual ProgressData::~ProgressData (   )  [inline, virtual]

Destructor.

---

Member Function Documentation

ProgressData& ProgressData::decr (  int  val_r = 1  )  [inline]

Decrement counter value (default by 1).

ProgressData& ProgressData::incr (  int  val_r = 1  )  [inline]

Increment counter value (default by 1).

ProgressData& ProgressData::init (  int  max_r  )  [inline]

Set min and counter value to 0 and new max value.

ProgressData& ProgressData::init (  int  min_r, int  max_r )  [inline]

Set new min, max value and counter value to min.

virtual ProgressData& ProgressData::init (  int  min_r, int  max_r, int  val_r )  [inline, virtual]

Set new min, max and counter value. Reimplemented in ProgressCounter.

int ProgressData::max (   )  const [inline]

Returns: Current max value.

virtual ProgressData& ProgressData::max (  int  max_r  )  [inline, virtual]

Set new max value. Reimplemented in ProgressCounter.

int ProgressData::min (   )  const [inline]

Returns: Current min value.

virtual ProgressData& ProgressData::min (  int  min_r  )  [inline, virtual]

Set new min value. Reimplemented in ProgressCounter.

ProgressData& ProgressData::operator= (  const ProgressData &  rhs  )  [inline]

Assignment via init Reimplemented in ProgressCounter.

ProgressData& ProgressData::range (  int  max_r  )  [inline]

Set min value to 0 and max value.

virtual ProgressData& ProgressData::range (  int  min_r, int  max_r )  [inline, virtual]

Set new min and max value. Reimplemented in ProgressCounter.

virtual ProgressData& ProgressData::set (  int  val_r  )  [inline, virtual]

Set new counter value. Reimplemented in ProgressCounter.

ProgressData& ProgressData::toMax (   )  [inline]

Set counter value to current max value.

ProgressData& ProgressData::toMin (   )  [inline]

Set counter value to current min value.

int ProgressData::val (   )  const [inline]

Returns: Current counter value.

---

Friends And Related Function Documentation

std::ostream& operator<< (  std::ostream &  str, const ProgressData &  obj )  [friend]

---

Member Data Documentation

int ProgressData::_max [private]

Current max value.

int ProgressData::_min [private]

Current min value.

int ProgressData::_val [private]

Current counter value.

---

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

• ProgressCounter.h

---