TePDIMixModelStrategy Class Reference
[Algorithm strategies.]

#include <TePDIMixModelStrategy.hpp>

Inheritance diagram for TePDIMixModelStrategy:

---

Detailed Description

This is the base class for mix models strategies.

Author:

Felipe Castro da Silva <felipe@dpi.inpe.br>

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

Definition at line 36 of file TePDIMixModelStrategy.hpp.

Public Types
typedef const TeSharedPtr < TePDIMixModelStrategy >	const_pointer
	Type definition for a const instance pointer.
typedef TeSharedPtr < TePDIMixModelStrategy >	pointer
	Type definition for a instance pointer.
Public Member Functions
bool	Apply (const TePDIParameters &params)
virtual bool	CheckParameters (const TePDIParameters &parameters) const =0
void	ToggleProgInt (bool enabled)
virtual	~TePDIMixModelStrategy ()
Static Public Member Functions
static TePDIMixModelStrategy *	DefaultObject (const TePDIParameters &)
Protected Member Functions
virtual bool	Implementation (const TePDIParameters &params)=0
	TePDIMixModelStrategy ()
Protected Attributes
bool	progress_interface_enabled_

---

Member Typedef Documentation

const TeSharedPtr< TePDIMixModelStrategy > TePDIMixModelStrategy::const_pointer

Reimplemented from TePDIStrategy.

Reimplemented in TePDIPrincoMixModelStrategy.

Definition at line 44 of file TePDIMixModelStrategy.hpp.

TeSharedPtr< TePDIMixModelStrategy > TePDIMixModelStrategy::pointer

Reimplemented from TePDIStrategy.

Reimplemented in TePDIPrincoMixModelStrategy.

Definition at line 40 of file TePDIMixModelStrategy.hpp.

---

Constructor & Destructor Documentation

TePDIMixModelStrategy::~TePDIMixModelStrategy

(

)

[virtual]

Default Destructor

Definition at line 10 of file TePDIMixModelStrategy.cpp.

{
};

TePDIMixModelStrategy::TePDIMixModelStrategy

(

)

[protected]

Default constructor

Parameters:

factoryName

Factory name.

Definition at line 5 of file TePDIMixModelStrategy.cpp.

{
};      

---

Member Function Documentation

bool TePDIStrategy::Apply

(

const TePDIParameters &

params

)

[inherited]

Applies the strategy.

Note:

Parameters checking will be performed.

Returns:

true if OK. false on error.

Definition at line 22 of file TePDIStrategy.cpp.

References TePDIStrategy::CheckParameters(), TePDIStrategy::Implementation(), and TEAGN_TRUE_OR_RETURN.

{
  TEAGN_TRUE_OR_RETURN( CheckParameters( params ), 
    "Parameter checking failed" );
    
  return Implementation( params );
}

virtual bool TePDIStrategy::CheckParameters

(

const TePDIParameters &

parameters

)

const [pure virtual, inherited]

Checks if the supplied parameters fits the requirements of each PDI strategy.

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.

Implemented in TePDIPrincoMixModelStrategy.

Referenced by TePDIStrategy::Apply().

TePDIMixModelStrategy * TePDIMixModelStrategy::DefaultObject

(

const TePDIParameters &

)

[static]

Returns a default object.

Returns:

A default object.

Reimplemented from TePDIStrategy.

Definition at line 15 of file TePDIMixModelStrategy.cpp.

References TEAGN_LOG_AND_THROW.

{
  TEAGN_LOG_AND_THROW( 
    "Trying to build an invalid mixmodel strategy instance" );
  return 0; 
}

virtual bool TePDIStrategy::Implementation

(

const TePDIParameters &

params

)

[protected, pure virtual, inherited]

Runs the algorithm implementation.

Returns:

true if OK. false on errors.

Implemented in TePDIPrincoMixModelStrategy.

Referenced by TePDIStrategy::Apply().

void TePDIStrategy::ToggleProgInt

(

bool

enabled

)

[inherited]

Enable / Disable the progress interface.

Parameters:

enabled

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

Definition at line 31 of file TePDIStrategy.cpp.

References TePDIStrategy::progress_interface_enabled_.

{
  progress_interface_enabled_ = enabled;
}

---

Field Documentation

bool TePDIStrategy::progress_interface_enabled_ [mutable, protected, inherited]

Progress interface enabled/disable flag

Definition at line 98 of file TePDIStrategy.hpp.

Referenced by TePDIPrincoMixModelStrategy::Implementation(), TePDIStrategy::TePDIStrategy(), and TePDIStrategy::ToggleProgInt().

---

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

• TePDIMixModelStrategy.hpp
• TePDIMixModelStrategy.cpp

---