A concrete class to compute the buffer operation. More...

#include <BufferMemory.h>

Inheritance diagram for te::vp::BufferMemory:

Public Member Functions
	BufferMemory ()
	Default constructor. More...

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

bool	run () throw (te::common::Exception)
	It executes the operation. More...

void	setInput (te::da::DataSourcePtr inDsrc, std::string inDsetName, std::auto_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 &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...

	~BufferMemory ()
	Destructor. More...

Protected Member Functions
void	dissolveMemory (te::mem::DataSet *outDSet, const int &levels)
	It dissolves the bounders between buffers. More...

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

double	getDistanceByAttribute (te::da::DataSet &dataSet, const int &position)
	It returns the distance of buffer by the attribute chosen. More...

te::gm::Geometry *	setBuffer (te::gm::Geometry geom, const double &distance, const int &level, te::gm::Geometry &auxGeom)
	It executes the buffer operator. 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::auto_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...

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

A concrete class to compute the buffer operation.

Definition at line 62 of file BufferMemory.h.

Constructor & Destructor Documentation

te::vp::BufferMemory::BufferMemory ( )

Default constructor.

te::vp::BufferMemory::~BufferMemory ( )

Destructor.

Member Function Documentation

void te::vp::BufferMemory::dissolveMemory	(	te::mem::DataSet *	outDSet,
		const int &	levels
	)

protected

It dissolves the bounders between buffers.

Parameters

outDSet	The dataSet with buffers.
levels	The number of levels the dataset has.

Note: The outDSet is updated with dissolved buffers.

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

protectedinherited

It builds the output DataSetType.

double te::vp::BufferMemory::getDistanceByAttribute	(	te::da::DataSet &	dataSet,
		const int &	position
	)

protected

It returns the distance of buffer by the attribute chosen.

Parameters

dataSet	The input dataSet with the value.
position	The position of attribute in dataSet.

Returns: The distance.

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

virtualinherited

It verifies if the parameters are valid.

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

bool te::vp::BufferMemory::run	(		)
throw	(	te::common::Exception
	)

virtual

It executes the operation.

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

Implements te::vp::BufferOp.

te::gm::Geometry* te::vp::BufferMemory::setBuffer	(	te::gm::Geometry *	geom,
		const double &	distance,
		const int &	level,
		te::gm::Geometry *&	auxGeom
	)

protected

It executes the buffer operator.

Parameters

geom	The input geometry.
distance	The distance to set buffer.
level	How many levels the buffer will have.
auxGeom	The auxiliar geometry that represents the previous buffer result. This parameter is important when the buffer result has more than one level.

Returns: A geometry with buffer result.

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

inherited

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

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

inherited

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.

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

inherited

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

int te::vp::BufferOp::m_attributePosition

protectedinherited

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

Definition at line 146 of file BufferOp.h.

int te::vp::BufferOp::m_bufferBoundariesRule

protectedinherited

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

Definition at line 143 of file BufferOp.h.

int te::vp::BufferOp::m_bufferPolygonRule

protectedinherited

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

Definition at line 142 of file BufferOp.h.

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

protectedinherited

The input datasettype.

Definition at line 138 of file BufferOp.h.

bool te::vp::BufferOp::m_copyInputColumns

protectedinherited

Copy columns from input DataSet.

Definition at line 144 of file BufferOp.h.

double te::vp::BufferOp::m_distance

protectedinherited

The fixed distance.

Definition at line 141 of file BufferOp.h.

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

protectedinherited

The input dataset name.

Definition at line 137 of file BufferOp.h.

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

protectedinherited

The input datasource.

Definition at line 136 of file BufferOp.h.

int te::vp::BufferOp::m_levels

protectedinherited

The number of levels buffer will have.

Definition at line 145 of file BufferOp.h.

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

protectedinherited

The input objectid set.

Definition at line 139 of file BufferOp.h.

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

protectedinherited

The output dataset name.

Definition at line 149 of file BufferOp.h.

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

protectedinherited

The output datasource.

Definition at line 148 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/BufferMemory.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation