te::rp::Composition Class Reference

Create a composition (a mosaic created using user defined rules) from a set of geo-referenced rasters. More...

#include <Composition.h>

Inheritance diagram for te::rp::Composition:

Classes
class	InputParameters
	Composition input parameters. More...
class	OutputParameters
	Composition output parameters. More...

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

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

Protected Attributes
Composition::InputParameters	m_inputParameters
	Input execution parameters. More...
bool	m_isInitialized
	Tells if this instance is initialized. More...

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

Detailed Description

Create a composition (a mosaic created using user defined rules) from a set of geo-referenced rasters.

Definition at line 44 of file Composition.h.

Constructor & Destructor Documentation

Composition()

te::rp::Composition::Composition

(

)

~Composition()

te::rp::Composition::~Composition

(

)

Member Function Documentation

execute()

bool te::rp::Composition::execute ( AlgorithmOutputParameters &  outputParams )

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()

Implements te::rp::Algorithm.

getErrorMessage()

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

inherited

Return the current error message if there is any.

Returns

Return the current error message if there is any.

initialize()

bool te::rp::Composition::initialize ( const AlgorithmInputParameters &  inputParams )

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()

Implements te::rp::Algorithm.

isInitialized()

bool te::rp::Composition::isInitialized ( ) const

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.

Implements te::rp::Algorithm.

reset()

void te::rp::Composition::reset ( )

virtual

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

Reimplemented from te::rp::Algorithm.

setErrorMessage()

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

protectedinherited

Set the current error message.

Parameters

newErrorMessage

New error message;

Member Data Documentation

m_errorMessage

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

privateinherited

Current error message.

Definition at line 104 of file Algorithm.h.

m_inputParameters

Composition::InputParameters te::rp::Composition::m_inputParameters

protected

Input execution parameters.

Definition at line 143 of file Composition.h.

m_isInitialized

bool te::rp::Composition::m_isInitialized

protected

Tells if this instance is initialized.

Definition at line 145 of file Composition.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/rp/Composition.h