Progress Class Reference

#include <Progress.hpp>

Inheritance diagram for Progress:

Public Member Functions
	Progress (const char *id="unknown")
virtual	~Progress ()
void	set_max (double max_value)
void	add_value (double incr_value)
double	scale (double fMax)
int	scale (int iMax)
bool	check_limits ()
virtual void	set_limits (double min_value, double max_value)
virtual void	set_value (double cur_value)
virtual void	set_comment (const char *text)
virtual Logic	user_break ()

Protected Member Functions
virtual void	update ()

Protected Attributes
char *	szName
double	vMin
double	vMax
double	vCur

Detailed Description

Base class for maintaining progress indicator. Here is the simpliest stdout implementation.

Constructor & Destructor Documentation

Progress::Progress

(

const char *

id = "unknown"

)

Create object which relates to progress indicator.

virtual Progress::~Progress ( )

virtual

Destroy object.

Member Function Documentation

void Progress::add_value

(

double

incr_value

)

Mark yet another piece of work as completed

bool Progress::check_limits

(

)

Check for current value is inside the proposed range

double Progress::scale

(

double

fMax

)

Scale vCur from vMin..vMax to 0..fMax/0..iMax

virtual void Progress::set_comment ( const char *  text )

virtual

Change text comment of the progress indicator view.

Reimplemented in QfProgress, and ZmProgress.

virtual void Progress::set_limits ( double  min_value, double  max_value  )

virtual

Set minimum and maximum allowed values of progress indicator

Reimplemented in QfProgress.

void Progress::set_max

(

double

max_value

)

Set maximum allowed value of progress indicator: 100%

virtual void Progress::set_value ( double  cur_value )

virtual

Set current value of progress; must be in range from 0 to max_value

Reimplemented in QfProgress.

virtual void Progress::update ( )

protectedvirtual

Update progress indicator view.

Reimplemented in QfProgress, ZmProgress, and ProgressPEP.

virtual Logic Progress::user_break ( )

virtual

Get interruption signal is set (TRUE) or not (FALSE).

Reimplemented in QfProgress, and ZmProgress.

Member Data Documentation

char* Progress::szName

protected

Symbolic id of the progress indicator

double Progress::vCur

protected

Current value of indicator

double Progress::vMax

protected

Maximum value of indicator

double Progress::vMin

protected

Minimum value of indicator

---

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

• /net/opt/univers/ubp-i-15.3-centos7-x64.urij/include/mix/Progress.hpp