te::vp::AbstractParameters Class Reference

Abstract class used to define the input/ ouptut parameters for TerraAmazon Operations. More...

#include <AbstractOperation.h>

Inheritance diagram for te::vp::AbstractParameters:

Public Member Functions
	AbstractParameters ()
	Default constructor. More...
void	addInputDataAccess (te::da::DataAccess *dataAccess)
	Adds an input data access to the params. More...
void	addOutputDataAccess (te::da::DataAccess *dataAccess)
	Adds an output data access to the params. Note that if the dataSet does not exist, it will be created by the operation. More...
const std::vector< te::da::DataAccess * > &	getInputDataAccessVector () const
	Returns the output dataAccess vector. More...
std::size_t	getMaxCoordinates () const
	Sets the input to be swapped. This is very usefull for operations between 2 dataSets. If TRUE, the input will be swapped. Default is FALSE. More...
OperationResult	getOperationResult () const
	Sets the result of the operation. More...
const std::vector< te::da::DataAccess * > &	getOutputDataAccessVector () const
	Sets the input dataAccess vector. More...
bool	getSwapInput () const
	Gets the result of the operation. More...
virtual bool	isValid (std::string &errorMessage)
	It checks the parameters for the operation. More...
void	reportParams (OperationReport *report)
	It reports each parameter used in the operation. More...
void	setInputDataAccessVector (const std::vector< te::da::DataAccess * > &vecDataAccess)
	Sets the output dataAccess vector. More...
void	setMaxCoordinates (std::size_t maxCoordinates)
	Returns the current state of the geometry subdivision. More...
void	setOperationResult (OperationResult result)
void	setOutputDataAccessVector (const std::vector< te::da::DataAccess * > &vecDataAccess)
	Enables or disables geometry subdivision. More...
void	setSwapInput (bool swap)
	Returns TRUE if the input must be swaped. FALSE otherwise. More...
virtual	~AbstractParameters ()=default
	Virtual destructor. More...

Protected Member Functions
virtual void	reportSpecificParams (OperationReport *report)
	It reports each specific parameter used in the operation. More...

Protected Attributes
std::vector< te::da::DataAccess * >	m_inputDataVector
	Vector with input dataAccess. More...
std::size_t	m_maxCoordinates
	If higher than 0, geometries will be subdivided until all the parts have less vertexes that this value. More...
OperationResult	m_operationResult
	Stores the result of the operation. More...
std::vector< te::da::DataAccess * >	m_outputDataVector
	Vector with output dataAccess. More...
bool	m_snapGeometries
	If TRUE, the geometries will be snapped before the operation is executed. Default is TRUE. More...
bool	m_swapInput
	This is very usefull for operations between 2 dataSets. If TRUE, the input will be swapped. Default is FALSE. More...

Detailed Description

Abstract class used to define the input/ ouptut parameters for TerraAmazon Operations.

Note

Not all parameters must be defined, each operation will validate the necessary parameters.

Definition at line 65 of file AbstractOperation.h.

Constructor & Destructor Documentation

AbstractParameters()

te::vp::AbstractParameters::AbstractParameters

(

)

Default constructor.

~AbstractParameters()

virtual te::vp::AbstractParameters::~AbstractParameters ( )

virtualdefault

Virtual destructor.

Member Function Documentation

addInputDataAccess()

void te::vp::AbstractParameters::addInputDataAccess

(

te::da::DataAccess *

dataAccess

)

Adds an input data access to the params.

Parameters

dataAccess

The input dataAccess to be added

addOutputDataAccess()

void te::vp::AbstractParameters::addOutputDataAccess

(

te::da::DataAccess *

dataAccess

)

Adds an output data access to the params. Note that if the dataSet does not exist, it will be created by the operation.

Parameters

dataAccess

The output dataAccess to be added Returns the input dataAccess vector

getInputDataAccessVector()

const std::vector< te::da::DataAccess * > & te::vp::AbstractParameters::getInputDataAccessVector

(

)

const

Returns the output dataAccess vector.

getMaxCoordinates()

std::size_t te::vp::AbstractParameters::getMaxCoordinates

(

)

const

Sets the input to be swapped. This is very usefull for operations between 2 dataSets. If TRUE, the input will be swapped. Default is FALSE.

getOperationResult()

OperationResult te::vp::AbstractParameters::getOperationResult

(

)

const

Sets the result of the operation.

getOutputDataAccessVector()

const std::vector< te::da::DataAccess * > & te::vp::AbstractParameters::getOutputDataAccessVector

(

)

const

Sets the input dataAccess vector.

getSwapInput()

bool te::vp::AbstractParameters::getSwapInput

(

)

const

Gets the result of the operation.

isValid()

virtual bool te::vp::AbstractParameters::isValid ( std::string &  errorMessage )

virtual

It checks the parameters for the operation.

Returns

True if the parameters is valid for this operation and false in other cases.

Reimplemented in te::vp::DissolveOperationParameters, and te::vp::DissolveSubdivisionOperationParameters.

reportParams()

void te::vp::AbstractParameters::reportParams

(

OperationReport *

report

)

It reports each parameter used in the operation.

Parameters

report

Object used to report operation information.

reportSpecificParams()

virtual void te::vp::AbstractParameters::reportSpecificParams ( OperationReport *  report )

protectedvirtual

It reports each specific parameter used in the operation.

Parameters

report

Object used to report operation information.

setInputDataAccessVector()

void te::vp::AbstractParameters::setInputDataAccessVector

(

const std::vector< te::da::DataAccess * > &

vecDataAccess

)

Sets the output dataAccess vector.

setMaxCoordinates()

void te::vp::AbstractParameters::setMaxCoordinates

(

std::size_t

maxCoordinates

)

Returns the current state of the geometry subdivision.

setOperationResult()

void te::vp::AbstractParameters::setOperationResult

(

OperationResult

result

)

setOutputDataAccessVector()

void te::vp::AbstractParameters::setOutputDataAccessVector

(

const std::vector< te::da::DataAccess * > &

vecDataAccess

)

Enables or disables geometry subdivision.

setSwapInput()

void te::vp::AbstractParameters::setSwapInput

(

bool

swap

)

Returns TRUE if the input must be swaped. FALSE otherwise.

Member Data Documentation

m_inputDataVector

std::vector<te::da::DataAccess*> te::vp::AbstractParameters::m_inputDataVector

protected

Vector with input dataAccess.

Definition at line 146 of file AbstractOperation.h.

m_maxCoordinates

std::size_t te::vp::AbstractParameters::m_maxCoordinates

protected

If higher than 0, geometries will be subdivided until all the parts have less vertexes that this value.

Definition at line 151 of file AbstractOperation.h.

m_operationResult

OperationResult te::vp::AbstractParameters::m_operationResult

protected

Stores the result of the operation.

Definition at line 150 of file AbstractOperation.h.

m_outputDataVector

std::vector<te::da::DataAccess*> te::vp::AbstractParameters::m_outputDataVector

protected

Vector with output dataAccess.

Definition at line 147 of file AbstractOperation.h.

m_snapGeometries

bool te::vp::AbstractParameters::m_snapGeometries

protected

If TRUE, the geometries will be snapped before the operation is executed. Default is TRUE.

Definition at line 149 of file AbstractOperation.h.

m_swapInput

bool te::vp::AbstractParameters::m_swapInput

protected

This is very usefull for operations between 2 dataSets. If TRUE, the input will be swapped. Default is FALSE.

Definition at line 148 of file AbstractOperation.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/vp/AbstractOperation.h