This class defines the RAG strategy to build a graph,. More...

#include <RAGGraphBuilder.h>

Inheritance diagram for te::graph::RAGGraphBuilder:

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

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

Methods
Methods used by this builder
bool	build (const std::string &shapeFileName, const std::string &linkColumn, const int &srid, const std::string &dsInfo, const std::string &graphType, const std::map< std::string, std::string > &gInfo)
	Function used to generated a graph using the RAG strategy. More...

Abstract Methods
Method common to each graph builder
std::string	getErrorMessage ()
	Get error message. More...

boost::shared_ptr< AbstractGraph >	getGraph ()
	Get generated graph. More...

Protected Member Functions
bool	createEdgeObjects (const std::string &shapeFileName, const std::string &linkColumn)
	Function used to create all edges object based on vectorial data. More...

bool	createVertexObjects (const std::string &shapeFileName, const std::string &linkColumn, const int &srid)
	Function used to create all vertex object based on vectorial data. More...

std::unique_ptr< te::da::DataSet >	getDataSet (te::da::DataSource *ds)
	Function used to get the data set with the vectorial data. More...

std::unique_ptr< te::da::DataSource >	getDataSource (const std::string &fileName)
	Function used to get the data source with the vectorial data. More...

int	getEdgeId ()
	Function used to generated the edge id. More...

bool	getGeometryColumn (const std::string &shapeFileName, std::string &columnName)
	Function used to get the geometry column name. More...

boost::ptr_vector< te::dt::Property >	getProperties (te::da::DataSource *ds)
	Function used to get the data source properties. More...

Protected Attributes
std::string	m_errorMessage
	Error message. More...

boost::shared_ptr< AbstractGraph >	m_graph
	Graph object. More...

Private Attributes
int	m_edgeId
	Attribute used as a index counter for edge objects. More...

Detailed Description

This class defines the RAG strategy to build a graph,.

This is strategy is based on adjacency of a region.

See also: AbstractGraphBuilder

Definition at line 66 of file RAGGraphBuilder.h.

Constructor & Destructor Documentation

te::graph::RAGGraphBuilder::RAGGraphBuilder ( )

Default constructor.

virtual te::graph::RAGGraphBuilder::~RAGGraphBuilder ( )

virtual

Virtual destructor.

Member Function Documentation

bool te::graph::RAGGraphBuilder::build	(	const std::string &	shapeFileName,
		const std::string &	linkColumn,
		const int &	srid,
		const std::string &	dsInfo,
		const std::string &	graphType,
		const std::map< std::string, std::string > &	gInfo
	)

Function used to generated a graph using the RAG strategy.

Parameters

shapeFileName	File name wiht vectorial data
linkColumn	Column name from vectorial data used as link column
srid	Vectorial projection id
dsInfo	Container with data source information
graphType	Attribute used to define the output graph type
gInfo	Container with graph generation parameters

Returns: True if the graph was correctly generated and false in other case.

bool te::graph::RAGGraphBuilder::createEdgeObjects	(	const std::string &	shapeFileName,
		const std::string &	linkColumn
	)

protected

Function used to create all edges object based on vectorial data.

Parameters

shapeFileName	File name wiht vectorial data
linkColumn	Column name from vectorial data used as link column

Returns: True if the edges was created correctly and false in othe case

bool te::graph::RAGGraphBuilder::createVertexObjects	(	const std::string &	shapeFileName,
		const std::string &	linkColumn,
		const int &	srid
	)

protected

Function used to create all vertex object based on vectorial data.

Parameters

shapeFileName	File name wiht vectorial data
linkColumn	Column name from vectorial data used as link column
srid	Vectorial projection id

Returns: True if the vertexs was created correctly and false in othe case

std::unique_ptr<te::da::DataSet> te::graph::RAGGraphBuilder::getDataSet ( te::da::DataSource * ds )

protected

Function used to get the data set with the vectorial data.

Returns: Data set.

std::unique_ptr<te::da::DataSource> te::graph::RAGGraphBuilder::getDataSource ( const std::string & fileName )

protected

Function used to get the data source with the vectorial data.

Returns: Data source.

int te::graph::RAGGraphBuilder::getEdgeId ( )

protected

Function used to generated the edge id.

Returns: Integer value as ID

std::string te::graph::AbstractGraphBuilder::getErrorMessage ( )

inherited

Get error message.

bool te::graph::RAGGraphBuilder::getGeometryColumn	(	const std::string &	shapeFileName,
		std::string &	columnName
	)

protected

Function used to get the geometry column name.

Parameters

shapeFileName	File name wiht vectorial data
columnName	Used to set the geometry column name

Returns: True if the the vectorial data was a geometry column and false in othe case

boost::shared_ptr<AbstractGraph> te::graph::AbstractGraphBuilder::getGraph ( )

inherited

Get generated graph.

boost::ptr_vector<te::dt::Property> te::graph::RAGGraphBuilder::getProperties ( te::da::DataSource * ds )

protected

Function used to get the data source properties.

Returns: A vector with all properties from a data source

Member Data Documentation

int te::graph::RAGGraphBuilder::m_edgeId

private

Attribute used as a index counter for edge objects.

Definition at line 171 of file RAGGraphBuilder.h.

std::string te::graph::AbstractGraphBuilder::m_errorMessage

protectedinherited

Error message.

Definition at line 84 of file AbstractGraphBuilder.h.

boost::shared_ptr<AbstractGraph> te::graph::AbstractGraphBuilder::m_graph

protectedinherited

Graph object.

Definition at line 82 of file AbstractGraphBuilder.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/graph/builder/RAGGraphBuilder.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation