te::rp::Algorithm Class Reference

Raster Processing algorithm base interface. More...

#include <Algorithm.h>

Inheritance diagram for te::rp::Algorithm:

Public Member Functions
virtual bool	execute (AlgorithmOutputParameters &outputParams) _NOEXCEPT_OP(false)=0
	Executes the algorithm using the supplied parameters. More...
const std::string &	getErrorMessage () const
	Return the current error message if there is any. More...
virtual bool	initialize (const AlgorithmInputParameters &inputParams) _NOEXCEPT_OP(false)=0
	Initialize the algorithm instance making it ready for execution. More...
virtual bool	isInitialized () const =0
	Returns true if the algorithm instance is initialized and ready for execution. More...
virtual void	reset () _NOEXCEPT_OP(false)
	Clear all internal allocated objects and reset the algorithm to its initial state. More...
virtual	~Algorithm ()

Protected Member Functions
	Algorithm ()
void	setErrorMessage (const std::string &newErrorMessage)
	Set the current error message. More...

Private Member Functions
	Algorithm (const Algorithm &)
Algorithm &	operator= (const Algorithm &)

Private Attributes
std::string	m_errorMessage
	Current error message. More...

Detailed Description

Raster Processing algorithm base interface.

Definition at line 41 of file Algorithm.h.

Constructor & Destructor Documentation

~Algorithm()

virtual te::rp::Algorithm::~Algorithm ( )

virtual

Algorithm() [1/2]

te::rp::Algorithm::Algorithm ( )

protected

Algorithm() [2/2]

te::rp::Algorithm::Algorithm ( const Algorithm &  )

private

Member Function Documentation

execute()

virtual bool te::rp::Algorithm::execute ( AlgorithmOutputParameters &  outputParams )

pure virtual

Executes the algorithm using the supplied parameters.

Parameters

outputParams

Output parameters.

Returns

true if OK, false on errors.

Note

A return error string can be obtained via Algorithm::getErrorMessage()

Implemented in te::rp::Contrast, te::rp::Segmenter, te::rp::MixtureModel, te::rp::Classifier, te::rp::SequenceMosaic, te::rp::ArithmeticOperations, te::rp::Skeleton, te::rp::WisperFusion, te::rp::TiePointsMosaic, te::rp::Filter, te::rp::IHSFusion, te::rp::Register, te::rp::GeoMosaic, te::rp::PCAFusion, te::rp::PostClassification, te::rp::TiePointsLocator, and te::rp::RasterAttributes.

getErrorMessage()

const std::string& te::rp::Algorithm::getErrorMessage

(

)

const

Return the current error message if there is any.

Returns

Return the current error message if there is any.

initialize()

virtual bool te::rp::Algorithm::initialize ( const AlgorithmInputParameters &  inputParams )

pure virtual

Initialize the algorithm instance making it ready for execution.

Parameters

inputParams

Input parameters.

Returns

true if OK, false on errors.

Note

A return error string can be obtained via Algorithm::getErrorMessage()

Implemented in te::rp::Contrast, te::rp::Segmenter, te::rp::MixtureModel, te::rp::Classifier, te::rp::SequenceMosaic, te::rp::ArithmeticOperations, te::rp::Skeleton, te::rp::WisperFusion, te::rp::TiePointsMosaic, te::rp::Filter, te::rp::IHSFusion, te::rp::Register, te::rp::GeoMosaic, te::rp::PCAFusion, te::rp::PostClassification, te::rp::TiePointsLocator, and te::rp::RasterAttributes.

isInitialized()

virtual bool te::rp::Algorithm::isInitialized ( ) const

pure virtual

Returns true if the algorithm instance is initialized and ready for execution.

Returns

true if the algorithm instance is initialized and ready for execution.

Implemented in te::rp::Contrast, te::rp::Segmenter, te::rp::MixtureModel, te::rp::Classifier, te::rp::SequenceMosaic, te::rp::ArithmeticOperations, te::rp::Skeleton, te::rp::WisperFusion, te::rp::TiePointsMosaic, te::rp::Filter, te::rp::IHSFusion, te::rp::Register, te::rp::GeoMosaic, te::rp::PCAFusion, te::rp::PostClassification, te::rp::TiePointsLocator, and te::rp::RasterAttributes.

operator=()

Algorithm& te::rp::Algorithm::operator= ( const Algorithm &  )

private

reset()

virtual void te::rp::Algorithm::reset ( )

virtual

Clear all internal allocated objects and reset the algorithm to its initial state.

Reimplemented in te::rp::Contrast, te::rp::Segmenter, te::rp::MixtureModel, te::rp::Classifier, te::rp::SequenceMosaic, te::rp::ArithmeticOperations, te::rp::Skeleton, te::rp::WisperFusion, te::rp::TiePointsMosaic, te::rp::Filter, te::rp::IHSFusion, te::rp::Register, te::rp::GeoMosaic, te::rp::PCAFusion, te::rp::PostClassification, te::rp::TiePointsLocator, and te::rp::RasterAttributes.

setErrorMessage()

void te::rp::Algorithm::setErrorMessage ( const std::string &  newErrorMessage )

protected

Set the current error message.

Parameters

newErrorMessage

New error message;

Member Data Documentation

m_errorMessage

std::string te::rp::Algorithm::m_errorMessage

private

Current error message.

Definition at line 104 of file Algorithm.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/rp/Algorithm.h