te::common::AbstractProgressViewer Class Reference

A class that defines the interface of an abstract progress viewer. More...

#include <AbstractProgressViewer.h>

Inheritance diagram for te::common::AbstractProgressViewer:

Public Member Functions
	AbstractProgressViewer ()
	Default constructor. More...
virtual void	addTask (TaskProgress *t, int id)=0
	Insert a new task in the progress viewer. More...
virtual void	cancelTask (int taskId)=0
	Cancel a task. More...
virtual void	removeTask (int taskId)=0
	Removes a task from progress viewer container. More...
virtual void	setTotalValues (int taskId)=0
	Set task total steps. More...
virtual void	updateMessage (int taskId)=0
	Update the progress message. More...
virtual void	updateValue (int taskId)=0
	Update the progress evaluation. More...
virtual	~AbstractProgressViewer ()
	Virtual destructor. More...

Detailed Description

A class that defines the interface of an abstract progress viewer.

See also

TaskProgress, ProgressManager

Definition at line 48 of file AbstractProgressViewer.h.

Constructor & Destructor Documentation

te::common::AbstractProgressViewer::AbstractProgressViewer ( )

inline

Default constructor.

Definition at line 53 of file AbstractProgressViewer.h.

virtual te::common::AbstractProgressViewer::~AbstractProgressViewer ( )

inlinevirtual

Virtual destructor.

Definition at line 56 of file AbstractProgressViewer.h.

References addTask(), cancelTask(), removeTask(), setTotalValues(), updateMessage(), and updateValue().

Member Function Documentation

virtual void te::common::AbstractProgressViewer::addTask ( TaskProgress *  t, int  id  )

pure virtual

Insert a new task in the progress viewer.

Parameters

t	Task pointer.
id	Task identifier.

Note

The Progress Viewer will NOT take the ownership of TaskProgress (t).

Implemented in te::qt::widgets::ProgressViewerBar, te::qt::widgets::ProgressViewerDialog, te::qt::widgets::ProgressViewerWidget, te::qt::widgets::ProgressViewerTaskWidget, and te::common::ConsoleProgressViewer.

Referenced by ~AbstractProgressViewer().

virtual void te::common::AbstractProgressViewer::cancelTask ( int  taskId )

pure virtual

Cancel a task.

Parameters

taskId

Task identifier.

Implemented in te::qt::widgets::ProgressViewerBar, te::qt::widgets::ProgressViewerDialog, te::qt::widgets::ProgressViewerWidget, te::qt::widgets::ProgressViewerTaskWidget, and te::common::ConsoleProgressViewer.

Referenced by ~AbstractProgressViewer().

virtual void te::common::AbstractProgressViewer::removeTask ( int  taskId )

pure virtual

Removes a task from progress viewer container.

Parameters

taskId

Task identifier.

Implemented in te::qt::widgets::ProgressViewerBar, te::qt::widgets::ProgressViewerDialog, te::qt::widgets::ProgressViewerWidget, te::qt::widgets::ProgressViewerTaskWidget, and te::common::ConsoleProgressViewer.

Referenced by ~AbstractProgressViewer().

virtual void te::common::AbstractProgressViewer::setTotalValues ( int  taskId )

pure virtual

Set task total steps.

Parameters

taskId

Task identifier.

Implemented in te::qt::widgets::ProgressViewerBar, te::qt::widgets::ProgressViewerDialog, te::qt::widgets::ProgressViewerWidget, te::qt::widgets::ProgressViewerTaskWidget, and te::common::ConsoleProgressViewer.

Referenced by ~AbstractProgressViewer().

virtual void te::common::AbstractProgressViewer::updateMessage ( int  taskId )

pure virtual

Update the progress message.

Parameters

taskId

Task identifier.

Implemented in te::qt::widgets::ProgressViewerDialog, te::qt::widgets::ProgressViewerBar, te::qt::widgets::ProgressViewerWidget, te::qt::widgets::ProgressViewerTaskWidget, and te::common::ConsoleProgressViewer.

Referenced by ~AbstractProgressViewer().

virtual void te::common::AbstractProgressViewer::updateValue ( int  taskId )

pure virtual

Update the progress evaluation.

Parameters

taskId

Task identifier.

Implemented in te::qt::widgets::ProgressViewerDialog, te::qt::widgets::ProgressViewerBar, te::qt::widgets::ProgressViewerWidget, te::qt::widgets::ProgressViewerTaskWidget, and te::common::ConsoleProgressViewer.

Referenced by ~AbstractProgressViewer().

---

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

• /home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/common/progress/AbstractProgressViewer.h