| TerraLib 4.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Protected Member Functions | Protected Attributes
TePDIPIManager Class Reference
Image processing auxiliary classes/methods.

This is the class for the active progress interface management. More...

`#include <TePDIPIManager.hpp>`

List of all members.

## Public Member Functions

| TePDIPIManager (const std::string &message=std::string(), unsigned long int tsteps=0, bool enabled=false)
| Default Constructor.
| ~TePDIPIManager ()
| Default Destructor.
void | Toggle (bool enabled)
| Enable / Disable the current progress interface manager.
bool | Update (unsigned long int step)
| Update the current progress interface to the supplied step.
bool | Increment ()
| Incriments the the current progress by one step.
void | Reset (const std::string &message=std::string(), unsigned long int tsteps=0)
| Reset the current instance state.
bool | wasCanceled ()
| Returns true if the progress was canceled.

## Protected Member Functions

bool | updateProgressInterface () const
| Updates the progress interface with the new settings.

## Protected Attributes

bool | enabled_
| A flag indicating if the PI manager is enabled.
unsigned long int | total_steps_
| The total steps number.
unsigned long int | curr_step_
| The current step.
TePDIPIManagerGlobalSettings & | global_settings_
| A reference to the global settings instance.
TeProgressBase * | prog_intef_ptr_
| A pointer to the active progress instance.
std::string | message_
| The progress interface message (label).

## Detailed Description

This is the class for the active progress interface management.

Author:
  Emiliano F. Castejon <castejon@dpi.inpe.br>

Note:
  This class is not thread safe by itself but multiple threads can access the global progress interface by instantiating their own TePDIPIManager instances.

Examples:

  TePDIOFMatching_test.cpp.

## Constructor & Destructor Documentation

TePDIPIManager::TePDIPIManager | ( | const std::string & | message = `std::string()`,
|  | unsigned long int | tsteps = `0`,
|  | bool | enabled = `false`
| ) |  |

Default Constructor.

Parameters:

  message | Progress window message (label).
  tsteps | Progress window total steps.
  enabled | Flag to enable ( true ) or disable ( false ).

TePDIPIManager::~TePDIPIManager | ( |  | ) |

Default Destructor.

## Member Function Documentation

bool TePDIPIManager::Increment | ( |  | ) | `[inline]`

Incriments the the current progress by one step.

Returns:
  true if the interface was canceled, false otherwise.

Examples:
  TePDIOFMatching_test.cpp.

void TePDIPIManager::Reset | ( | const std::string & | message = `std::string()`,
|  | unsigned long int | tsteps = `0`
| ) |  |

Reset the current instance state.

Parameters:

  message | Message (label).
  tsteps | Total steps.

void TePDIPIManager::Toggle | ( | bool | enabled | ) |

Enable / Disable the current progress interface manager.

Parameters:

  enabled | Flag to enable ( true ) or disable ( false ).

bool TePDIPIManager::Update | ( | unsigned long int | step | ) |

Update the current progress interface to the supplied step.

Parameters:

  step | Current step.

Returns:
  true if the interface was canceled, false otherwise.

bool TePDIPIManager::updateProgressInterface | ( |  | ) | const`[protected]`

Updates the progress interface with the new settings.

Note:
  NO LOCK DONE !!

Parameters:

  settings | The new progress interface manager to be applied.
  prog_intef_ptr | Progres interface pointer.

Returns:
  true if the interface was canceled, false otherwise.

bool TePDIPIManager::wasCanceled | ( |  | ) | `[inline]`

Returns true if the progress was canceled.

Returns:
  Returns true if the progress was canceled.

## Member Data Documentation

unsigned long int TePDIPIManager::curr_step_`[protected]`

The current step.

bool TePDIPIManager::enabled_`[protected]`

A flag indicating if the PI manager is enabled.

TePDIPIManagerGlobalSettings& TePDIPIManager::global_settings_`[protected]`

A reference to the global settings instance.

std::string TePDIPIManager::message_`[protected]`

The progress interface message (label).

TeProgressBase* TePDIPIManager::prog_intef_ptr_`[protected]`

A pointer to the active progress instance.

Note:
  null if no active instance is present.

unsigned long int TePDIPIManager::total_steps_`[protected]`

The total steps number.

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

- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/image_processing/TePDIPIManager.hpp
- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/image_processing/TePDIPIManager.cpp

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines