An abstract class to compute the buffer memory and buffer query operation. More...

#include <BufferOp.h>

Inheritance diagram for te::vp::BufferOp:

Public Member Functions
	BufferOp ()
	Default constructor that can be called by subclasses. More...

virtual bool	paramsAreValid ()
	It verifies if the parameters are valid. More...

virtual bool	run ()=0
	It executes the operation. More...

void	setInput (te::da::DataSourcePtr inDsrc, std::string inDsetName, std::unique_ptr< te::da::DataSetTypeConverter > converter, const te::da::ObjectIdSet *oidSet=0)
	It sets the input data will be calculated. More...

void	setOutput (te::da::DataSourcePtr outDsrc, std::string dsname)
	It sets the output parameters that will be used to persist operation result. More...

void	setParams (const double &distance, const int &newSrid, const int &bufferPolygonRule, const int &bufferBoundariesRule, const bool &copyInputColumns, const int &levels, const int &attributePosition=-1)
	It sets the input parameters that will be consumed to execute the operation. More...

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

Protected Member Functions
te::da::DataSetType *	GetDataSetType ()
	It builds the output DataSetType. More...

Protected Attributes
int	m_attributePosition
	The buffer can be calculated by attribute values. The attribute must be numeric type. More...

int	m_bufferBoundariesRule
	The buffer boundary rule (DISSOLVE = 0 and NOT_DISSOLVE = 1). More...

int	m_bufferPolygonRule
	The buffer polygon rule (INSIDE_OUTSIDE = 0, ONLY_OUTSIDE = 1, ONLY_INSIDE = 2). More...

std::unique_ptr< te::da::DataSetTypeConverter >	m_converter
	The input datasettype. More...

bool	m_copyInputColumns
	Copy columns from input DataSet. More...

double	m_distance
	The fixed distance. More...

std::string	m_inDsetName
	The input dataset name. More...

te::da::DataSourcePtr	m_inDsrc
	The input datasource. More...

int	m_levels
	The number of levels buffer will have. More...

int	m_newSRID
	A new SRID if it's necessary to transform the data. More...

const te::da::ObjectIdSet *	m_oidSet
	The input objectid set. More...

std::string	m_outDsetName
	The output dataset name. More...

te::da::DataSourcePtr	m_outDsrc
	The output datasource. More...

Detailed Description

An abstract class to compute the buffer memory and buffer query operation.

Definition at line 61 of file BufferOp.h.

Constructor & Destructor Documentation

◆ BufferOp()

te::vp::BufferOp::BufferOp ( )

Default constructor that can be called by subclasses.

◆ ~BufferOp()

virtual te::vp::BufferOp::~BufferOp ( )

inlinevirtual

Virtual destructor.

Definition at line 69 of file BufferOp.h.

Member Function Documentation

◆ GetDataSetType()

te::da::DataSetType* te::vp::BufferOp::GetDataSetType ( )

protected

It builds the output DataSetType.

◆ paramsAreValid()

virtual bool te::vp::BufferOp::paramsAreValid ( )

virtual

It verifies if the parameters are valid.

Returns: A Boolean value that means if the operation successfully completed or not.

◆ run()

virtual bool te::vp::BufferOp::run ( )

pure virtual

It executes the operation.

Returns: A Boolean value that means if the operation successfully completed or not.

Implemented in te::vp::BufferMemory, and te::vp::BufferQuery.

◆ setInput()

void te::vp::BufferOp::setInput	(	te::da::DataSourcePtr	inDsrc,
		std::string	inDsetName,
		std::unique_ptr< te::da::DataSetTypeConverter >	converter,
		const te::da::ObjectIdSet *	oidSet = `0`
	)

It sets the input data will be calculated.

Parameters

inDsrc	Where data is located.
inDsetName	DataSet name.
converter	DataSetTypeConverterr.
oidSet	ObjectIdSet - It is necessary if has need to execute with a set of specific objects

◆ setOutput()

void te::vp::BufferOp::setOutput	(	te::da::DataSourcePtr	outDsrc,
		std::string	dsname
	)

It sets the output parameters that will be used to persist operation result.

Parameters

outDsrc	Where data is will be persisted.
dsname	The name os output data.

Note: The output name must be different from other data that is already in dataSource.

◆ setParams()

void te::vp::BufferOp::setParams	(	const double &	distance,
		const int &	newSrid,
		const int &	bufferPolygonRule,
		const int &	bufferBoundariesRule,
		const bool &	copyInputColumns,
		const int &	levels,
		const int &	attributePosition = `-1`
	)

It sets the input parameters that will be consumed to execute the operation.

Parameters

distance	A numeric value to set a fixed distance to buffer.
bufferPolygonRule	The rule used for buffer result (INSIDE_OUTSIDE = 0, ONLY_OUTSIDE = 1, ONLY_INSIDE = 2).
bufferBoundariesRule	The BoundariesBetweenBuffers can be dissolved or not - (DISSOLVE = 0 and NOT_DISSOLVE = 1).
copyInputColumns	Copy columns from input DataSet.
levels	The number of levels buffer will have.
attributePosition	The buffer can be calculated by attribute values. The attribute must be numeric type.

Note: If uses attibutePosition parameter, the fixed distance will be ignored.; The attributePosition parameter must be numeric type.; If there is a null value or zero in chosen attribute, the line that has this value will be ignored.

Member Data Documentation

◆ m_attributePosition

int te::vp::BufferOp::m_attributePosition

protected

The buffer can be calculated by attribute values. The attribute must be numeric type.

Definition at line 148 of file BufferOp.h.

◆ m_bufferBoundariesRule

int te::vp::BufferOp::m_bufferBoundariesRule

protected

The buffer boundary rule (DISSOLVE = 0 and NOT_DISSOLVE = 1).

Definition at line 145 of file BufferOp.h.

◆ m_bufferPolygonRule

int te::vp::BufferOp::m_bufferPolygonRule

protected

The buffer polygon rule (INSIDE_OUTSIDE = 0, ONLY_OUTSIDE = 1, ONLY_INSIDE = 2).

Definition at line 144 of file BufferOp.h.

◆ m_converter

std::unique_ptr<te::da::DataSetTypeConverter> te::vp::BufferOp::m_converter

protected

The input datasettype.

Definition at line 139 of file BufferOp.h.

◆ m_copyInputColumns

bool te::vp::BufferOp::m_copyInputColumns

protected

Copy columns from input DataSet.

Definition at line 146 of file BufferOp.h.

◆ m_distance

double te::vp::BufferOp::m_distance

protected

The fixed distance.

Definition at line 142 of file BufferOp.h.

◆ m_inDsetName

std::string te::vp::BufferOp::m_inDsetName

protected

The input dataset name.

Definition at line 138 of file BufferOp.h.

◆ m_inDsrc

te::da::DataSourcePtr te::vp::BufferOp::m_inDsrc

protected

The input datasource.

Definition at line 137 of file BufferOp.h.

◆ m_levels

int te::vp::BufferOp::m_levels

protected

The number of levels buffer will have.

Definition at line 147 of file BufferOp.h.

◆ m_newSRID

int te::vp::BufferOp::m_newSRID

protected

A new SRID if it's necessary to transform the data.

Definition at line 143 of file BufferOp.h.

◆ m_oidSet

const te::da::ObjectIdSet* te::vp::BufferOp::m_oidSet

protected

The input objectid set.

Definition at line 140 of file BufferOp.h.

◆ m_outDsetName

std::string te::vp::BufferOp::m_outDsetName

protected

The output dataset name.

Definition at line 151 of file BufferOp.h.

◆ m_outDsrc

te::da::DataSourcePtr te::vp::BufferOp::m_outDsrc

protected

The output datasource.

Definition at line 150 of file BufferOp.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/vp/BufferOp.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BufferOp()

◆ ~BufferOp()

Member Function Documentation

◆ GetDataSetType()

◆ paramsAreValid()

◆ run()

◆ setInput()

◆ setOutput()

◆ setParams()

Member Data Documentation

◆ m_attributePosition

◆ m_bufferBoundariesRule

◆ m_bufferPolygonRule

◆ m_converter

◆ m_copyInputColumns

◆ m_distance

◆ m_inDsetName

◆ m_inDsrc

◆ m_levels

◆ m_newSRID

◆ m_oidSet

◆ m_outDsetName

◆ m_outDsrc