[an error occurred while processing this directive]

AppBase::MultiProgressDisplay Class Reference

The progress display is used to report progress to another part of the program. More...

#include <ProgressDisplayOld.h>

Inheritance diagram for AppBase::MultiProgressDisplay:

[legend]List of all members.

Public Member Functions
	MultiProgressDisplay (double minPrintStep=0.02)
virtual	~MultiProgressDisplay ()
void	pushTask (const ProgressTask &task)
	create a new progress display for a task.
void	popTask ()
	remove a task from the progress display
void	setShortMessage (const std::string &msg)
	change the message text of the current task
void	setMessage (const std::string &msg)
	change the message text of the current task
void	setProgress (double progress)
	set progress (affects this task and all tasks above it)
void	increase ()
	increase progress by a substep.
Protected Member Functions
virtual void	updateProgressDisplay ()
	template method, to update the display
virtual void	taskAdded ()
	template method, called when a task is added
virtual void	taskRemove ()
	template method, called just before the task is removed
void	propagateProgress (double progress)
	propagate progress to next level
Protected Attributes
std::vector< ProgressTask >	tasks
double	m_minProgressStep

---

Detailed Description

The progress display is used to report progress to another part of the program.

This enables the utility classes to report progress both to the statusbar if there is one, or a textmode, for applications without GUI, or no progress at all, with this default class.

This is the better class, and shows the whole hierachy of progress messages.

---

Constructor & Destructor Documentation

AppBase::MultiProgressDisplay::MultiProgressDisplay (  double  minPrintStep = 0.02  )

virtual AppBase::MultiProgressDisplay::~MultiProgressDisplay (   )  [inline, virtual]

---

Member Function Documentation

void AppBase::MultiProgressDisplay::increase (   )

increase progress by a substep. Reimplemented in AppBase::DummyMultiProgressDispaly.

void AppBase::MultiProgressDisplay::popTask (   )

remove a task from the progress display Reimplemented in AppBase::DummyMultiProgressDispaly.

void AppBase::MultiProgressDisplay::propagateProgress (  double  progress  )  [protected]

propagate progress to next level

void AppBase::MultiProgressDisplay::pushTask (  const ProgressTask &  task  )

create a new progress display for a task. once the operation is finished int must popTask() the progress display. Parameters: msg  string of the message subStepIncr  finishing the subtask below increases the current progress by subTaskIncr Reimplemented in AppBase::DummyMultiProgressDispaly.

void AppBase::MultiProgressDisplay::setMessage (  const std::string &  msg  )

change the message text of the current task Reimplemented in AppBase::DummyMultiProgressDispaly.

void AppBase::MultiProgressDisplay::setProgress (  double  progress  )

set progress (affects this task and all tasks above it) Reimplemented in AppBase::DummyMultiProgressDispaly.

void AppBase::MultiProgressDisplay::setShortMessage (  const std::string &  msg  )

change the message text of the current task Reimplemented in AppBase::DummyMultiProgressDispaly.

virtual void AppBase::MultiProgressDisplay::taskAdded (   )  [inline, protected, virtual]

template method, called when a task is added Reimplemented in AppBase::DummyMultiProgressDispaly, AppBase::MultiProgressDisplayAdaptor, and AppBase::StreamMultiProgressDisplay.

virtual void AppBase::MultiProgressDisplay::taskRemove (   )  [inline, protected, virtual]

template method, called just before the task is removed Reimplemented in AppBase::DummyMultiProgressDispaly, AppBase::MultiProgressDisplayAdaptor, and AppBase::StreamMultiProgressDisplay.

virtual void AppBase::MultiProgressDisplay::updateProgressDisplay (   )  [inline, protected, virtual]

template method, to update the display should be provided by subclasses. Reimplemented in AppBase::DummyMultiProgressDispaly, AppBase::MultiProgressDisplayAdaptor, and AppBase::StreamMultiProgressDisplay.

---

Member Data Documentation

double AppBase::MultiProgressDisplay::m_minProgressStep [protected]

std::vector<ProgressTask> AppBase::MultiProgressDisplay::tasks [protected]

---

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

• hugin_base/appbase/ProgressDisplayOld.h
• hugin_base/appbase/ProgressDisplayOld.cpp

---