| 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
TeDTMAlgorithm Class Reference
General purpose DTM algorithms.

This is the base class for DTM algorithms. More...

`#include <TeDTMAlgorithm.h>`

List of all members.

## Public Member Functions

virtual | ~TeDTMAlgorithm ()
| Default Destructor.
bool | apply ()
| Applies the algorithm following the current state and internal stored parameters.
bool | reset (const TeDTMParameters &params)
| Reset the internal state with new supplied parameters.
virtual bool | checkParameters (const TeDTMParameters &parameters) const =0
| Checks if the supplied parameters fits the requirements of each DTM algorithm implementation.
const TeDTMParameters & | getParameters () const
| Returns a reference to the current internal parameters.
void | toggleProgInt (bool enabled)
| Enable / Disable the progress interface.

## Protected Member Functions

| TeDTMAlgorithm ()
| Default Constructor.
virtual bool | runImplementation ()=0
| Runs the current algorithm implementation.
virtual void | resetState (const TeDTMParameters &params)=0
| Reset the internal state to the initial state.
bool | checkInternalParameters () const
| Checks if current internal parameters fits the requirements of each DTM algorithm implementation.

## Protected Attributes

TeDTMParameters | params_
| Internal parameters reference.
bool | progress_enabled_
| The internal progress interface enabled state.

## Detailed Description

This is the base class for DTM algorithms.

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

## Constructor & Destructor Documentation

TeDTMAlgorithm::~TeDTMAlgorithm | ( |  | ) | `[virtual]`

Default Destructor.

TeDTMAlgorithm::TeDTMAlgorithm | ( |  | ) | `[protected]`

Default Constructor.

## Member Function Documentation

bool TeDTMAlgorithm::apply | ( |  | ) |

Applies the algorithm following the current state and internal stored parameters.

Returns:
  true if OK. false on error.

bool TeDTMAlgorithm::checkInternalParameters | ( |  | ) | const`[protected]`

Checks if current internal parameters fits the requirements of each DTM algorithm implementation.

Note:
  Error log messages must be generated. No exceptions generated.

Returns:
  true if the internal parameters are OK. false if not.

virtual bool TeDTMAlgorithm::checkParameters | ( | const TeDTMParameters & | parameters | ) | const`[pure virtual]`

Checks if the supplied parameters fits the requirements of each DTM algorithm implementation.

Note:
  Error log messages must be generated. No exceptions generated.

Parameters:

  parameters | The parameters to be checked.

Returns:
  true if the parameters are OK. false if not.

const TeDTMParameters & TeDTMAlgorithm::getParameters | ( |  | ) | const

Returns a reference to the current internal parameters.

Returns:
  A reference to the current internal parameters.

bool TeDTMAlgorithm::reset | ( | const TeDTMParameters & | params | ) |

Reset the internal state with new supplied parameters.

Parameters:

  params | The new supplied parameters.

Returns:
  true if parameters OK, false on error.

virtual void TeDTMAlgorithm::resetState | ( | const TeDTMParameters & | params | ) | `[protected, pure virtual]`

Reset the internal state to the initial state.

Parameters:

  params | The new parameters referente at initial state.

virtual bool TeDTMAlgorithm::runImplementation | ( |  | ) | `[protected, pure virtual]`

Runs the current algorithm implementation.

Returns:
  true if OK. false on error.

void TeDTMAlgorithm::toggleProgInt | ( | bool | enabled | ) |

Enable / Disable the progress interface.

Parameters:

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

## Member Data Documentation

TeDTMParameters TeDTMAlgorithm::params_`[mutable, protected]`

Internal parameters reference.

bool TeDTMAlgorithm::progress_enabled_`[protected]`

The internal progress interface enabled state.

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

- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/dtm/TeDTMAlgorithm.h
- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/dtm/TeDTMAlgorithm.cpp

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines