Abstract class used to define an operation. More...

#include <AbstractOperation.h>

Inheritance diagram for te::vp::AbstractOperation:

Public Member Functions
void	abort ()
	Returns TRUE if the operation has been aborted. FALSE otherwise. More...

	AbstractOperation (const std::string &operationName)
	Default constructor. More...

virtual te::vp::Feature *	createOutputFeature (std::size_t outputIndex)
	It creates the output feature based on the given output dataaccess index. More...

virtual std::vector< te::vp::FeatureSet >	execute (const std::vector< te::vp::FeatureSet > &vecInput)
	It executes the operation. More...

virtual std::unique_ptr< te::vp::AbstractOperationCapabilities >	getCapabilities () const
	Makes all the necessaries adaptations to the input dataAccess to avoid duplicate column names. More...

virtual const te::da::DataSetType *	getDataSetType (std::size_t outputIndex)
	Gets the dataSetType of the 'outputIndex-th' output. More...

const std::string &	getName () const
	Gets the output geometry type. More...

te::gm::GeomType	getOutputGeometryType () const

AbstractParameters *	getParameters () const
	Gets the operation report. More...

OperationReport *	getReport () const
	Gets the operation name. More...

bool	handleOutputPropertyNamesChanges (const te::da::DataSetType baseOutputDataSetType, const te::da::DataSetType actualOutputDataSetType)

virtual void	initialize ()

bool	isAborted () const
	Get the capabilities of the operation. Basically, operation will have 2 inputs, 1 output, and support subdivision. If it is not the case of the concrete class, this function should be overriden. More...

bool	prepareInputData ()

bool	prepareOutputData ()

void	setOutputGeometryType (const te::gm::GeomType newType)
	Set the output geometry type. More...

void	setParameters (AbstractParameters *params)
	Gets the operation current parameters. More...

virtual	~AbstractOperation ()
	Virtual destructor. More...

Protected Member Functions
virtual void	addOutputColumns (te::da::DataSetType *outputDataSetType)
	Initializes the operation input. More...

virtual te::da::DataSetType *	createBasicOutputDataSetType (const std::string &dataSetName, int srid, te::gm::GeomType geometryType, const std::string &geometryColumnName) const
	< Creates the basic dataSetType for the output containing all the columns that are required More...

virtual std::vector< te::vp::FeatureSet >	executeImpl (const std::vector< te::vp::FeatureSet > &vecInput)=0

virtual bool	initializeInput ()
	Initializes the operation output. More...

virtual bool	initializeOutput ()
	Function that effectivelly executes the operation. It must be implemented by the concrete classes. More...

Protected Attributes
bool	m_aborted
	Becames true if the abort function is called. Concrete classes must check for this value from time to time. More...

AbstractOperationImpl *	m_impl
	Holds all the attributes of the class. More...

Detailed Description

Abstract class used to define an operation.

Definition at line 203 of file AbstractOperation.h.

Constructor & Destructor Documentation

◆ AbstractOperation()

te::vp::AbstractOperation::AbstractOperation ( const std::string & operationName )

Default constructor.

Note: This class will take the ownership of AbstractParameters pointer

◆ ~AbstractOperation()

virtual te::vp::AbstractOperation::~AbstractOperation ( )

virtual

Virtual destructor.

Initializes the operation input and output

Member Function Documentation

◆ abort()

void te::vp::AbstractOperation::abort ( )

Returns TRUE if the operation has been aborted. FALSE otherwise.

◆ addOutputColumns()

virtual void te::vp::AbstractOperation::addOutputColumns ( te::da::DataSetType * outputDataSetType )

protectedvirtual

Initializes the operation input.

◆ createBasicOutputDataSetType()

virtual te::da::DataSetType* te::vp::AbstractOperation::createBasicOutputDataSetType	(	const std::string &	dataSetName,
		int	srid,
		te::gm::GeomType	geometryType,
		const std::string &	geometryColumnName
	)		const

protectedvirtual

< Creates the basic dataSetType for the output containing all the columns that are required

Reimplemented in te::vp::SubdivideOperation.

◆ createOutputFeature()

virtual te::vp::Feature* te::vp::AbstractOperation::createOutputFeature ( std::size_t outputIndex )

virtual

It creates the output feature based on the given output dataaccess index.

Parameters

outputIndex The index of the output dataAccess.

◆ execute()

virtual std::vector<te::vp::FeatureSet> te::vp::AbstractOperation::execute ( const std::vector< te::vp::FeatureSet > & vecInput )

virtual

It executes the operation.

Parameters

input Input vector data to be processed.

Precondition: The parameters must be valid (internal check)

Exceptions

Exception It throws an exception if something goes wrong during the execution.

\Return The output memory data processed.

◆ executeImpl()

virtual std::vector<te::vp::FeatureSet> te::vp::AbstractOperation::executeImpl ( const std::vector< te::vp::FeatureSet > & vecInput )

protectedpure virtual

Implemented in te::vp::SubdivideOperation, te::vp::MakeValidOperation, te::vp::IdentityOperation, te::vp::UnionOperation, te::vp::IntersectionOperation, te::vp::DissolveSubdivisionOperation, te::vp::DissolveOperation, and te::vp::DifferenceOperation.

◆ getCapabilities()

virtual std::unique_ptr<te::vp::AbstractOperationCapabilities> te::vp::AbstractOperation::getCapabilities ( ) const

virtual

Makes all the necessaries adaptations to the input dataAccess to avoid duplicate column names.

Reimplemented in te::vp::SubdivideOperation, te::vp::MakeValidOperation, te::vp::DissolveSubdivisionOperation, and te::vp::DissolveOperation.

◆ getDataSetType()

virtual const te::da::DataSetType* te::vp::AbstractOperation::getDataSetType ( std::size_t outputIndex )

virtual

Gets the dataSetType of the 'outputIndex-th' output.

Parameters

outputIndex The index of the output dataAccess. Sets the parameters to be used by the operation

◆ getName()

const std::string& te::vp::AbstractOperation::getName ( ) const

Gets the output geometry type.

◆ getOutputGeometryType()

te::gm::GeomType te::vp::AbstractOperation::getOutputGeometryType ( ) const

◆ getParameters()

AbstractParameters* te::vp::AbstractOperation::getParameters ( ) const

Gets the operation report.

◆ getReport()

OperationReport* te::vp::AbstractOperation::getReport ( ) const

Gets the operation name.

◆ handleOutputPropertyNamesChanges()

bool te::vp::AbstractOperation::handleOutputPropertyNamesChanges	(	const te::da::DataSetType *	baseOutputDataSetType,
		const te::da::DataSetType *	actualOutputDataSetType
	)

◆ initialize()

virtual void te::vp::AbstractOperation::initialize ( )

virtual

Reimplemented in te::vp::UnionOperation, and te::vp::IdentityOperation.

◆ initializeInput()

virtual bool te::vp::AbstractOperation::initializeInput ( )

protectedvirtual

Initializes the operation output.

◆ initializeOutput()

virtual bool te::vp::AbstractOperation::initializeOutput ( )

protectedvirtual

Function that effectivelly executes the operation. It must be implemented by the concrete classes.

◆ isAborted()

bool te::vp::AbstractOperation::isAborted ( ) const

Get the capabilities of the operation. Basically, operation will have 2 inputs, 1 output, and support subdivision. If it is not the case of the concrete class, this function should be overriden.

◆ prepareInputData()

bool te::vp::AbstractOperation::prepareInputData ( )

◆ prepareOutputData()

bool te::vp::AbstractOperation::prepareOutputData ( )

◆ setOutputGeometryType()

void te::vp::AbstractOperation::setOutputGeometryType ( const te::gm::GeomType newType )

Set the output geometry type.

Note: Default value: te::gm::UnknownGeometryType Aborts the execution of the operation

◆ setParameters()

void te::vp::AbstractOperation::setParameters ( AbstractParameters * params )

Gets the operation current parameters.

Member Data Documentation

◆ m_aborted

bool te::vp::AbstractOperation::m_aborted

protected

Becames true if the abort function is called. Concrete classes must check for this value from time to time.

Definition at line 303 of file AbstractOperation.h.

◆ m_impl

AbstractOperationImpl* te::vp::AbstractOperation::m_impl

protected

Holds all the attributes of the class.

Definition at line 302 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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AbstractOperation()

◆ ~AbstractOperation()

Member Function Documentation

◆ abort()

◆ addOutputColumns()

◆ createBasicOutputDataSetType()

◆ createOutputFeature()

◆ execute()

◆ executeImpl()

◆ getCapabilities()

◆ getDataSetType()

◆ getName()

◆ getOutputGeometryType()

◆ getParameters()

◆ getReport()

◆ handleOutputPropertyNamesChanges()

◆ initialize()

◆ initializeInput()

◆ initializeOutput()

◆ isAborted()

◆ prepareInputData()

◆ prepareOutputData()

◆ setOutputGeometryType()

◆ setParameters()

Member Data Documentation

◆ m_aborted

◆ m_impl