te::rp::Register Class Reference

Performs raster data registering into a SRS using a set of tie points. More...

#include <Register.h>

Inheritance diagram for te::rp::Register:

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

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

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

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

Private Attributes
std::string	m_errorMessage
	Current error message.

Detailed Description

Performs raster data registering into a SRS using a set of tie points.

Definition at line 48 of file Register.h.

Constructor & Destructor Documentation

Register()

te::rp::Register::Register

(

)

~Register()

te::rp::Register::~Register

(

)

Member Function Documentation

execute()

bool te::rp::Register::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::Register::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::Register::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::Register::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

Register::InputParameters te::rp::Register::m_inputParameters

protected

Input execution parameters.

Definition at line 152 of file Register.h.

m_isInitialized

bool te::rp::Register::m_isInitialized

protected

Tells if this instance is initialized.

Definition at line 154 of file Register.h.

---

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

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