MULTIPR_ProgressCallback Class Reference

#include <MULTIPR_ProgressCallback.hxx>

Public Member Functions
	MULTIPR_ProgressCallback ()
	Builds a new MULTIPR_ProgressCallback (default constructor).
virtual	~MULTIPR_ProgressCallback ()
	Destructor.
virtual void	start (const char *pTaskTitle, int pNumSteps)=0
	Starts to provide feedback on the progress of a slow operation.
void	moveOn ()
	Moves on the current amount of progress made.
virtual void	done ()=0
	Termines to provide feedback.
void	init (int pNumSteps)
	Resets this progress callback.
virtual void	progress (float pPercent)=0
	Callback.
Data Fields
int	mCurrentStep
int	mTotalSteps

---

Constructor & Destructor Documentation

MULTIPR_ProgressCallback.MULTIPR_ProgressCallback

(

)

Builds a new MULTIPR_ProgressCallback (default constructor).

References init().

virtual MULTIPR_ProgressCallback.~MULTIPR_ProgressCallback

(

)

[virtual]

Destructor.

Removes everything.

---

Member Function Documentation

virtual void MULTIPR_ProgressCallback.start	(	const char *	pTaskTitle,
		int	pNumSteps
	)			[pure virtual]

Starts to provide feedback on the progress of a slow operation.

Parameters:

	pTaskTitle	name of the task to be monitored.
	pNumSteps	number of steps in the task.

void MULTIPR_ProgressCallback.moveOn

(

)

Moves on the current amount of progress made.

References mCurrentStep, mTotalSteps, and progress().

virtual void MULTIPR_ProgressCallback.done

(

)

[pure virtual]

Termines to provide feedback.

void MULTIPR_ProgressCallback.init

(

int

pNumSteps

)

Resets this progress callback.

Parameters:

pNumSteps

number of steps in the task to be monitored.

References mCurrentStep, and mTotalSteps.

virtual void MULTIPR_ProgressCallback.progress

(

float

pPercent

)

[pure virtual]

Callback.

Called on each progress.

Parameters:

pPercent

percent accomplished.

---

Field Documentation

int MULTIPR_ProgressCallback.mCurrentStep

int MULTIPR_ProgressCallback.mTotalSteps