This class can be used to inform the progress of a task. More...

#include <TaskProgress.h>

Public Types
enum	{ UNDEFINED = 0 , DRAW = 1 }
	Defines some task types. More...

Public Member Functions
void	cancel ()
	Cancel task, set the task active FALSE. More...

int	getCurrentStep () const
	Get the task current step. More...

int	getId () const
	Get the task identification. More...

const std::string &	getMessage () const
	Get the task message. More...

int	getProportionalValue () const
	Get the proportional value (value between 0 and 100). More...

int	getTotalSteps () const
	Get the task total stepes. More...

unsigned int	getType () const
	Get the task type. More...

bool	hasToUpdate () const
	This function is used when proportional value has changed. More...

bool	isActive () const
	Verify if the task is active. More...

void	pulse ()
	Calls setCurrentStep() function using getCurrentStep() + 1. More...

void	setCurrentStep (int value)
	Set the task current step. More...

void	setMessage (const std::string &message)
	Set the task message. More...

void	setTotalSteps (int value)
	Set the task total stepes. More...

	TaskProgress (const std::string &message="", unsigned int type=UNDEFINED, int totalSteps=0)
	Default constructor. More...

void	useMultiThread (bool flag)
	Used to define if task is running in thread mode. More...

void	useTimer (bool flag)
	Used to define if task use progress timer information. More...

	~TaskProgress ()
	Destructor. More...

Protected Attributes
int	m_currentPropStep
	Current proportinal step. More...

int	m_currentStep
	Task current step. More...

bool	m_hasToUpdate
	Flag used to indicate the update status. More...

int	m_id
	Task identification. More...

bool	m_isActive
	Flag used to indicate the task status. More...

bool	m_isMultiThread
	Flag used to indicate the thread mode. More...

std::string	m_message
	Task message. More...

ProgressTimer *	m_timer
	Progress timer instance. More...

int	m_totalSteps
	Task total steps. More...

unsigned int	m_type
	Task type. More...

bool	m_useTimer
	Flag used to indicate the timer status. More...

Detailed Description

This class can be used to inform the progress of a task.

See also: ProgressTimer, ProgressManager

Definition at line 53 of file TaskProgress.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Defines some task types.

Enumerator
UNDEFINED	Undefined task type.
DRAW	Draw task type.

Definition at line 58 of file TaskProgress.h.

Constructor & Destructor Documentation

◆ TaskProgress()

te::common::TaskProgress::TaskProgress	(	const std::string &	message = `""`,
		unsigned int	type = `UNDEFINED`,
		int	totalSteps = `0`
	)

Default constructor.

The constructor will register the task in the progress manager.

◆ ~TaskProgress()

te::common::TaskProgress::~TaskProgress ( )

Destructor.

The destructor will remove the task from the progress manager.

Member Function Documentation

◆ cancel()

void te::common::TaskProgress::cancel ( )

Cancel task, set the task active FALSE.

◆ getCurrentStep()

int te::common::TaskProgress::getCurrentStep ( ) const

Get the task current step.

Returns: Current step as integer value.

◆ getId()

int te::common::TaskProgress::getId ( ) const

Get the task identification.

Returns: Task id as integer value.

◆ getMessage()

const std::string & te::common::TaskProgress::getMessage ( ) const

Get the task message.

Returns: String value with task message.

◆ getProportionalValue()

int te::common::TaskProgress::getProportionalValue ( ) const

Get the proportional value (value between 0 and 100).

Returns: Proportional value as integer.

◆ getTotalSteps()

int te::common::TaskProgress::getTotalSteps ( ) const

Get the task total stepes.

Returns: Integer value with total steps.

◆ getType()

unsigned int te::common::TaskProgress::getType ( ) const

Get the task type.

Returns: The task type.

◆ hasToUpdate()

bool te::common::TaskProgress::hasToUpdate ( ) const

This function is used when proportional value has changed.

Returns: True if progress has to be update and false in other case.

◆ isActive()

bool te::common::TaskProgress::isActive ( ) const

Verify if the task is active.

Returns: True if task is active and false in other case.

Referenced by te::rp::rg::mergeSegments().

◆ pulse()

void te::common::TaskProgress::pulse ( )

Calls setCurrentStep() function using getCurrentStep() + 1.

Referenced by te::cl::KMeans< TTRAIN, TCLASSIFY >::classify(), and te::cl::KMeans< TTRAIN, TCLASSIFY >::train().

◆ setCurrentStep()

void te::common::TaskProgress::setCurrentStep ( int value )

Set the task current step.

Parameters

value Current value.

◆ setMessage()

void te::common::TaskProgress::setMessage ( const std::string & message )

Set the task message.

Parameters

message String value with task message.

◆ setTotalSteps()

void te::common::TaskProgress::setTotalSteps ( int value )

Set the task total stepes.

Parameters

value Interger value with total steps.

◆ useMultiThread()

void te::common::TaskProgress::useMultiThread ( bool flag )

Used to define if task is running in thread mode.

Parameters

flag	Boolean value used to set the thread option.

◆ useTimer()

void te::common::TaskProgress::useTimer ( bool flag )

Used to define if task use progress timer information.

Parameters

flag	Boolean value used to set the timer option.

Member Data Documentation

◆ m_currentPropStep

int te::common::TaskProgress::m_currentPropStep

protected

Current proportinal step.

Definition at line 181 of file TaskProgress.h.

◆ m_currentStep

int te::common::TaskProgress::m_currentStep

protected

Task current step.

Definition at line 180 of file TaskProgress.h.

◆ m_hasToUpdate

bool te::common::TaskProgress::m_hasToUpdate

protected

Flag used to indicate the update status.

Definition at line 183 of file TaskProgress.h.

◆ m_id

int te::common::TaskProgress::m_id

protected

Task identification.

Definition at line 177 of file TaskProgress.h.

◆ m_isActive

bool te::common::TaskProgress::m_isActive

protected

Flag used to indicate the task status.

Definition at line 184 of file TaskProgress.h.

◆ m_isMultiThread

bool te::common::TaskProgress::m_isMultiThread

protected

Flag used to indicate the thread mode.

Definition at line 185 of file TaskProgress.h.

◆ m_message

std::string te::common::TaskProgress::m_message

protected

Task message.

Definition at line 182 of file TaskProgress.h.

◆ m_timer

ProgressTimer* te::common::TaskProgress::m_timer

protected

Progress timer instance.

Definition at line 187 of file TaskProgress.h.

◆ m_totalSteps

int te::common::TaskProgress::m_totalSteps

protected

Task total steps.

Definition at line 179 of file TaskProgress.h.

◆ m_type

unsigned int te::common::TaskProgress::m_type

protected

Task type.

Definition at line 178 of file TaskProgress.h.

◆ m_useTimer

bool te::common::TaskProgress::m_useTimer

protected

Flag used to indicate the timer status.

Definition at line 186 of file TaskProgress.h.

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

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TaskProgress()

◆ ~TaskProgress()

Member Function Documentation

◆ cancel()

◆ getCurrentStep()

◆ getId()

◆ getMessage()

◆ getProportionalValue()

◆ getTotalSteps()

◆ getType()

◆ hasToUpdate()

◆ isActive()

◆ pulse()

◆ setCurrentStep()

◆ setMessage()

◆ setTotalSteps()

◆ useMultiThread()

◆ useTimer()

Member Data Documentation

◆ m_currentPropStep

◆ m_currentStep

◆ m_hasToUpdate

◆ m_id

◆ m_isActive

◆ m_isMultiThread

◆ m_message

◆ m_timer

◆ m_totalSteps

◆ m_type

◆ m_useTimer