te::rp::GeoMosaic Class Reference

Create a mosaic from a set of geo-referenced rasters. More...

#include <GeoMosaic.h>

Inheritance diagram for te::rp::GeoMosaic:
te::rp::Algorithm

Classes

class  InputParameters
 GeoMosaic input parameters. More...
 
class  OutputParameters
 GeoMosaic output parameters. More...
 

Public Member Functions

bool execute (AlgorithmOutputParameters &outputParams) _NOEXCEPT_OP(false)
 Executes the algorithm using the supplied parameters. More...
 
 GeoMosaic ()
 
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...
 
 ~GeoMosaic ()
 

Protected Member Functions

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

Protected Attributes

GeoMosaic::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 mosaic from a set of geo-referenced rasters.

Definition at line 49 of file GeoMosaic.h.

Constructor & Destructor Documentation

◆ GeoMosaic()

te::rp::GeoMosaic::GeoMosaic ( )

◆ ~GeoMosaic()

te::rp::GeoMosaic::~GeoMosaic ( )

Member Function Documentation

◆ execute()

bool te::rp::GeoMosaic::execute ( AlgorithmOutputParameters outputParams)
virtual

Executes the algorithm using the supplied parameters.

Parameters
outputParamsOutput 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::GeoMosaic::initialize ( const AlgorithmInputParameters inputParams)
virtual

Initialize the algorithm instance making it ready for execution.

Parameters
inputParamsInput 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::GeoMosaic::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::GeoMosaic::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
newErrorMessageNew 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

GeoMosaic::InputParameters te::rp::GeoMosaic::m_inputParameters
protected

Input execution parameters.

Definition at line 161 of file GeoMosaic.h.

◆ m_isInitialized

bool te::rp::GeoMosaic::m_isInitialized
protected

Tells if this instance is initialized.

Definition at line 163 of file GeoMosaic.h.


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