te::sa::GPMBuilder Class Reference

This class defines the GPM Builder class. More...

#include <GPMBuilder.h>

Public Member Functions
	GPMBuilder (GPMConstructorAbstractStrategy *constructor, GPMWeightsAbstractStrategy *weights)
	Default constructor. More...
virtual	~GPMBuilder ()
	Virtual destructor. More...

Methods
Methods used by the GPM builder
GPMConstructorAbstractStrategy *	m_constructor
	Strategy used to construct the gpm. More...
GPMWeightsAbstractStrategy *	m_weights
	Strategy used to calculate the weight of a gpm. More...
std::unique_ptr< GeneralizedProximityMatrix >	m_gpm
	GPM reference pointer. More...
te::da::DataSourcePtr	m_ds
	Input Data Source. More...
bool	setGPMInfo (te::da::DataSourcePtr ds, const std::string &dataSetName, const std::string &attributeName)
	Function used to create an empty gpm (using a MEMORY DIRECT graph) More...
void	build ()
GeneralizedProximityMatrix *	getGPM ()
	Function used to return the generated gpm. More...

Detailed Description

This class defines the GPM Builder class.

Definition at line 54 of file GPMBuilder.h.

Constructor & Destructor Documentation

GPMBuilder()

te::sa::GPMBuilder::GPMBuilder	(	GPMConstructorAbstractStrategy *	constructor,
		GPMWeightsAbstractStrategy *	weights
	)

Default constructor.

~GPMBuilder()

virtual te::sa::GPMBuilder::~GPMBuilder ( )

virtual

Virtual destructor.

Member Function Documentation

build()

void te::sa::GPMBuilder::build

(

)

getGPM()

GeneralizedProximityMatrix* te::sa::GPMBuilder::getGPM

(

)

Function used to return the generated gpm.

Note

: The caller will be responsible for checking if it received a valid pointer;

: The caller will receive ownership of the returned pointer;

Returns

GeneralizedProximityMatrix A pointer to the matrix generated by the builder.

setGPMInfo()

bool te::sa::GPMBuilder::setGPMInfo	(	te::da::DataSourcePtr	ds,
		const std::string &	dataSetName,
		const std::string &	attributeName
	)

Function used to create an empty gpm (using a MEMORY DIRECT graph)

Parameters

ds	Data source pointer
dataSetName	Container with data source information
attributeName	Attribute used to define the output graph type

Returns

True if the gmp was correctly generated and false in other case.

Member Data Documentation

m_constructor

GPMConstructorAbstractStrategy* te::sa::GPMBuilder::m_constructor

private

Strategy used to construct the gpm.

Definition at line 99 of file GPMBuilder.h.

m_ds

te::da::DataSourcePtr te::sa::GPMBuilder::m_ds

private

Input Data Source.

Definition at line 105 of file GPMBuilder.h.

m_gpm

std::unique_ptr<GeneralizedProximityMatrix> te::sa::GPMBuilder::m_gpm

private

GPM reference pointer.

Definition at line 103 of file GPMBuilder.h.

m_weights

GPMWeightsAbstractStrategy* te::sa::GPMBuilder::m_weights

private

Strategy used to calculate the weight of a gpm.

Definition at line 101 of file GPMBuilder.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/sa/core/GPMBuilder.h