All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
te::common::ProgressTimer Class Reference

The ProgressTimer is a utility class that can be used to calculate the estimated time to finish a task. More...

#include <ProgressTimer.h>

Public Member Functions

std::string getMessage ()
 Get the information about the evolution of the process. More...
 
double getRemainingTimeInMin () const
 Function used to get the remaining time to end the process. More...
 
double getSpeedTimeInSec () const
 Function used to get the speed time. More...
 
 ProgressTimer (int totalSteps)
 It initializes a ProgressTimer. More...
 
void setTotalSteps (int totalSteps)
 Set the total steps. More...
 
void start ()
 Start the internal timer. More...
 
void tick ()
 Define a new step process evolution. More...
 
 ~ProgressTimer ()
 Destructor. More...
 

Private Attributes

int m_count
 Internal counter. More...
 
double m_remainingTime
 Remaining time in minutes. More...
 
double m_speedTime
 Speed time in seconds. More...
 
time_t m_startTime
 Initial time. More...
 
int m_totalSteps
 Total steps. More...
 

Detailed Description

The ProgressTimer is a utility class that can be used to calculate the estimated time to finish a task.

See Also
TaskProgress

Definition at line 47 of file ProgressTimer.h.

Constructor & Destructor Documentation

te::common::ProgressTimer::ProgressTimer ( int  totalSteps)

It initializes a ProgressTimer.

Definition at line 31 of file ProgressTimer.cpp.

te::common::ProgressTimer::~ProgressTimer ( )

Destructor.

Definition at line 40 of file ProgressTimer.cpp.

Member Function Documentation

std::string te::common::ProgressTimer::getMessage ( )

Get the information about the evolution of the process.

Returns
String with the information about remaining and speed time.

Definition at line 88 of file ProgressTimer.cpp.

References te::common::Convert2String(), and TR_COMMON.

double te::common::ProgressTimer::getRemainingTimeInMin ( ) const

Function used to get the remaining time to end the process.

Returns
Dobule value, the remaingin time in minutes.

Definition at line 78 of file ProgressTimer.cpp.

double te::common::ProgressTimer::getSpeedTimeInSec ( ) const

Function used to get the speed time.

Returns
Double value, the spped time in seconds.

Definition at line 83 of file ProgressTimer.cpp.

void te::common::ProgressTimer::setTotalSteps ( int  totalSteps)

Set the total steps.

Definition at line 73 of file ProgressTimer.cpp.

void te::common::ProgressTimer::start ( )

Start the internal timer.

Definition at line 44 of file ProgressTimer.cpp.

void te::common::ProgressTimer::tick ( )

Define a new step process evolution.

Note
For each tick, new values for remaining time and speed time are computed.

Definition at line 52 of file ProgressTimer.cpp.

Member Data Documentation

int te::common::ProgressTimer::m_count
private

Internal counter.

Definition at line 95 of file ProgressTimer.h.

double te::common::ProgressTimer::m_remainingTime
private

Remaining time in minutes.

Definition at line 97 of file ProgressTimer.h.

double te::common::ProgressTimer::m_speedTime
private

Speed time in seconds.

Definition at line 98 of file ProgressTimer.h.

time_t te::common::ProgressTimer::m_startTime
private

Initial time.

Definition at line 96 of file ProgressTimer.h.

int te::common::ProgressTimer::m_totalSteps
private

Total steps.

Definition at line 94 of file ProgressTimer.h.

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