A singleton class used to manage tasks progresses and their viewers. More...

#include <ProgressManager.h>

Inheritance diagram for te::common::ProgressManager:

Public Types
typedef ObjectLevelLockingPolicy< ::boost::lock_guard< ::boost::recursive_mutex > >	LockRead

typedef ObjectLevelLockingPolicy< ::boost::lock_guard< ::boost::recursive_mutex > >	LockWrite

typedef volatile ProgressManager	VolatileType

Public Member Functions
int	addTask (TaskProgress *tp)
	Used in TaskProgress constructor, register this task generating a task id. More...

int	addViewer (AbstractProgressViewer *apv)
	Attach a progress viewer. More...

void	cancelTask (int taskId)
	Inform all viewers that a task was canceled. More...

void	cancelTasks (unsigned int type)
	Cancels the task with the given task type and inform all viewers that a task was canceled. More...

void	clearAll ()
	Removes references for Viewers and tasks. More...

void	removeTask (int taskId)
	Used in TaskProgress destructor, remove task from singleton. More...

void	removeViewer (int viewerId)
	Dettach a progress viewer (AbstractProgressViewer destructor calls this method). More...

void	setSuspendViewers (bool flag)

void	setTotalValues (int taskId)
	Inform all viewers that a task set the total values. More...

void	updateMessage (int taskId)
	Inform all viewers that a task set the message. More...

void	updateValue (int taskId)
	Inform all viewers that a task set the current step. More...

Static Public Member Functions
static ProgressManager &	getInstance ()
	It returns a reference to the singleton instance. More...

Protected Member Functions
int	generateTaskId ()
	Used to generate a new task id (use internal counter). More...

int	generateViewerId ()
	Used to generate a new viewer id (use internal counter). More...

	ProgressManager ()
	Default constructor. More...

	~ProgressManager ()
	Destructor. More...

Protected Attributes
bool	m_suspendViewers

int	m_taskCounter
	Counter used to generate a task id. More...

std::map< int, TaskProgress * >	m_tasks
	Container with tasks. More...

int	m_viewerCounter
	Counter used to generate a viewer id. More...

std::map< int, AbstractProgressViewer * >	m_viewers
	Container with viewers. More...

Private Attributes
::boost::recursive_mutex	m_mtx
	The mutex used to control the object lock. More...

Friends
class	te::common::Singleton< ProgressManager >

Detailed Description

A singleton class used to manage tasks progresses and their viewers.

This singleton is used to store all tasks created and their progress viewers. If one or more viewers is attached, all instances will be used to display the tasks progresses.

See also: AbstractProgressViewer, TaskProgress

Definition at line 59 of file ProgressManager.h.

Member Typedef Documentation

◆ LockRead

typedef ObjectLevelLockingPolicy<::boost::lock_guard< ::boost::recursive_mutex > > te::common::ObjectLevelLockable< ProgressManager , ::boost::recursive_mutex , ::boost::lock_guard< ::boost::recursive_mutex > , ::boost::lock_guard< ::boost::recursive_mutex > >::LockRead

inherited

Definition at line 205 of file ThreadingPolicies.h.

◆ LockWrite

typedef ObjectLevelLockingPolicy<::boost::lock_guard< ::boost::recursive_mutex > > te::common::ObjectLevelLockable< ProgressManager , ::boost::recursive_mutex , ::boost::lock_guard< ::boost::recursive_mutex > , ::boost::lock_guard< ::boost::recursive_mutex > >::LockWrite

inherited

Definition at line 206 of file ThreadingPolicies.h.

◆ VolatileType

typedef volatile ProgressManager te::common::ObjectLevelLockable< ProgressManager , ::boost::recursive_mutex , ::boost::lock_guard< ::boost::recursive_mutex > , ::boost::lock_guard< ::boost::recursive_mutex > >::VolatileType

inherited

Definition at line 204 of file ThreadingPolicies.h.

Constructor & Destructor Documentation

◆ ProgressManager()

te::common::ProgressManager::ProgressManager ( )

protected

Default constructor.

◆ ~ProgressManager()

te::common::ProgressManager::~ProgressManager ( )

protected

Destructor.

Member Function Documentation

◆ addTask()

int te::common::ProgressManager::addTask ( TaskProgress * tp )

Used in TaskProgress constructor, register this task generating a task id.

Parameters

tp	TaskProgress instance

Returns: Task identifier

Note: Thread-safe!

◆ addViewer()

int te::common::ProgressManager::addViewer ( AbstractProgressViewer * apv )

Attach a progress viewer.

Parameters

apv	Progress viewer instance

Note

◆ cancelTask()

void te::common::ProgressManager::cancelTask ( int taskId )

Inform all viewers that a task was canceled.

Parameters

taskId Task identifier.

◆ cancelTasks()

void te::common::ProgressManager::cancelTasks ( unsigned int type )

Cancels the task with the given task type and inform all viewers that a task was canceled.

Parameters

type	The task type.

◆ clearAll()

void te::common::ProgressManager::clearAll ( )

Removes references for Viewers and tasks.

◆ generateTaskId()

int te::common::ProgressManager::generateTaskId ( )

protected

Used to generate a new task id (use internal counter).

Returns: Task identification as integer value.

◆ generateViewerId()

int te::common::ProgressManager::generateViewerId ( )

protected

Used to generate a new viewer id (use internal counter).

Returns: Viewer identification as integer value.

◆ getInstance()

ProgressManager & te::common::Singleton< ProgressManager >::getInstance

inlinestaticinherited

It returns a reference to the singleton instance.

Returns: A reference to the singleton instance.

Definition at line 109 of file Singleton.h.

◆ removeTask()

void te::common::ProgressManager::removeTask ( int taskId )

Used in TaskProgress destructor, remove task from singleton.

Parameters

taskId Task identifier.

Note: Thread-safe!

◆ removeViewer()

void te::common::ProgressManager::removeViewer ( int viewerId )

Dettach a progress viewer (AbstractProgressViewer destructor calls this method).

Parameters

viewerId Progress viewer identifier

◆ setSuspendViewers()

void te::common::ProgressManager::setSuspendViewers ( bool flag )

inline

Definition at line 145 of file ProgressManager.h.

◆ setTotalValues()

void te::common::ProgressManager::setTotalValues ( int taskId )

Inform all viewers that a task set the total values.

Parameters

taskId Task identifier.

◆ updateMessage()

void te::common::ProgressManager::updateMessage ( int taskId )

Inform all viewers that a task set the message.

Parameters

taskId Task identifier.

◆ updateValue()

void te::common::ProgressManager::updateValue ( int taskId )

Inform all viewers that a task set the current step.

Parameters

taskId Task identifier.

Friends And Related Function Documentation

◆ te::common::Singleton< ProgressManager >

friend class te::common::Singleton< ProgressManager >

friend

Definition at line 59 of file ProgressManager.h.

Member Data Documentation

◆ m_mtx

::boost::recursive_mutex te::common::ObjectLevelLockable< ProgressManager , ::boost::recursive_mutex , ::boost::lock_guard< ::boost::recursive_mutex > , ::boost::lock_guard< ::boost::recursive_mutex > >::m_mtx

mutableprivateinherited

The mutex used to control the object lock.

Definition at line 232 of file ThreadingPolicies.h.

◆ m_suspendViewers

bool te::common::ProgressManager::m_suspendViewers

protected

Definition at line 176 of file ProgressManager.h.

◆ m_taskCounter

int te::common::ProgressManager::m_taskCounter

protected

Counter used to generate a task id.

Definition at line 171 of file ProgressManager.h.

◆ m_tasks

std::map<int, TaskProgress*> te::common::ProgressManager::m_tasks

protected

Container with tasks.

Definition at line 173 of file ProgressManager.h.

◆ m_viewerCounter

int te::common::ProgressManager::m_viewerCounter

protected

Counter used to generate a viewer id.

Definition at line 172 of file ProgressManager.h.

◆ m_viewers

std::map<int, AbstractProgressViewer*> te::common::ProgressManager::m_viewers

protected

Container with viewers.

Definition at line 174 of file ProgressManager.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/common/progress/ProgressManager.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ LockRead

◆ LockWrite

◆ VolatileType

Constructor & Destructor Documentation

◆ ProgressManager()

◆ ~ProgressManager()

Member Function Documentation

◆ addTask()

◆ addViewer()

◆ cancelTask()

◆ cancelTasks()

◆ clearAll()

◆ generateTaskId()

◆ generateViewerId()

◆ getInstance()

◆ removeTask()

◆ removeViewer()

◆ setSuspendViewers()

◆ setTotalValues()

◆ updateMessage()

◆ updateValue()

Friends And Related Function Documentation

◆ te::common::Singleton< ProgressManager >

Member Data Documentation

◆ m_mtx

◆ m_suspendViewers

◆ m_taskCounter

◆ m_tasks

◆ m_viewerCounter

◆ m_viewers