This is the main graph implementation, that uses a cache policy anda graph loader to get all elements inside a data source. More...

#include <Graph.h>

Inheritance diagram for te::graph::Graph:

Public Member Functions
	Graph ()
	constructor.

	Graph (AbstractCachePolicy cp, AbstractGraphLoaderStrategy ls)
	Constructor.

	Graph (GraphMetadata *metadata)
	Constructor.

	~Graph ()
	Virtual destructor.

Vertex Access Methods
Method used to access vertex elements from a graph.
virtual void	add (Vertex *v)
	Add a new vertex element to a graph.

virtual void	update (Vertex *v)
	Update the vertex element.

virtual void	removeVertex (int id)
	This function removes the vertex element from graph, also was removed in data source.

virtual te::graph::Vertex *	getVertex (int id)
	It returns the vertex element if it's exist.

virtual void	addVertexProperty (te::dt::Property *p)
	Add a new property associated to the vertex element.

virtual void	removeVertexProperty (int idx)
	Remove a property associated to the vertex element.

virtual te::dt::Property *	getVertexProperty (int idx)
	Get a vertex property given a index.

virtual int	getVertexPropertySize ()
	Used to verify the number of properties associated to vertex elements.

Edge Access Methods
Method used to access edge elements from a graph.
GraphDataManager *	m_dataManager
	Used to load and save GraphData information from a DataSource.

GraphCache *	m_graphCache
	Class used to keep all graph data loaded.

GraphMetadata *	m_metadata
	Graph Data loader strategy.

GraphData *	m_graphData
	This class has the graph data and properties.

virtual void	add (Edge *e)
	Add a new edge element to a graph.

virtual void	update (Edge *e)
	Update the edge element.

virtual void	removeEdge (int id)
	This function removes the edge element from graph, also was removed in data source.

virtual te::graph::Edge *	getEdge (int id)
	It returns the edge element if it's exist.

virtual void	addEdgeProperty (te::dt::Property *p)
	Add a new property associated to the edge element.

virtual void	removeEdgeProperty (int idx)
	Remove a property associated to the edge element.

virtual te::dt::Property *	getEdgeProperty (int idx)
	Get a edge property given a index.

virtual int	getEdgePropertySize ()
	Used to verify the number of properties associated to edge elements.

virtual te::graph::GraphMetadata *	getMetadata ()
	Function used to access the graph metadata.

virtual void	flush ()
	Function used to clear the memory cache, all elements was released from memory, if any element was changes it will be saved.

Detailed Description

This is the main graph implementation, that uses a cache policy anda graph loader to get all elements inside a data source.

All methods to access a graph element (vertex or edge) will use the GraphData instance, if not found the element, the class GraphCache will be consulted.

See also: AbstractGraph, GraphData, GraphCache

Definition at line 72 of file Graph.h.

Constructor & Destructor Documentation

◆ Graph() [1/3]

te::graph::Graph::Graph ( )

constructor.

◆ Graph() [2/3]

te::graph::Graph::Graph ( GraphMetadata * metadata )

Constructor.

Parameters

metadata A pointer to a graph metadata implementation

◆ Graph() [3/3]

te::graph::Graph::Graph	(	AbstractCachePolicy *	cp,
		AbstractGraphLoaderStrategy *	ls
	)

Constructor.

Parameters

cp	A pointer to a cache policy implementation
ls	A pointer to a loader strategy implementation

◆ ~Graph()

te::graph::Graph::~Graph ( )

Virtual destructor.

Member Function Documentation

◆ add() [1/2]

virtual void te::graph::Graph::add ( Edge * e )

virtual

Add a new edge element to a graph.

Parameters

e	Edge element

Note: This function turns the dirty flag of current GraphData to true, the new flag of the edge turns to true.

Implements te::graph::AbstractGraph.

Reimplemented in te::graph::BidirectionalGraph, te::graph::DirectedGraph, and te::graph::UndirectedGraph.

◆ add() [2/2]

virtual void te::graph::Graph::add ( Vertex * v )

virtual

Add a new vertex element to a graph.

Parameters

v	Vertex element

Note: This function turns the dirty flag of current GraphData to true, the new flag of the vertex turns to true.

Implements te::graph::AbstractGraph.

◆ addEdgeProperty()

virtual void te::graph::Graph::addEdgeProperty ( te::dt::Property * p )

virtual

Add a new property associated to the edge element.

param p New property to be associated with edge elements.

Note: It's important before using this function call the flush() function, its necessary to force the memory clear and the elements will be loaded with the right size of properties.

Implements te::graph::AbstractGraph.

◆ addVertexProperty()

virtual void te::graph::Graph::addVertexProperty ( te::dt::Property * p )

virtual

Add a new property associated to the vertex element.

param p New property to be associated with vertex elements.

Note: It's important before using this function call the flush() function, its necessary to force the memory clear and the elements will be loaded with the right size of properties.

Implements te::graph::AbstractGraph.

◆ flush()

virtual void te::graph::Graph::flush ( )

virtual

Function used to clear the memory cache, all elements was released from memory, if any element was changes it will be saved.

Returns

Implements te::graph::AbstractGraph.

◆ getEdge()

virtual te::graph::Edge * te::graph::Graph::getEdge ( int id )

virtual

It returns the edge element if it's exist.

Parameters

id	Vertex identification

Returns: A valid vertex point if the element was found and a null pointer in other case.

Implements te::graph::AbstractGraph.

◆ getEdgeProperty()

virtual te::dt::Property * te::graph::Graph::getEdgeProperty ( int idx )

virtual

Get a edge property given a index.

Parameters

idx	Index of the property

Returns: A property associated to the edge element if the index is right and a null pointer in other case.

Implements te::graph::AbstractGraph.

◆ getEdgePropertySize()

virtual int te::graph::Graph::getEdgePropertySize ( )

virtual

Used to verify the number of properties associated to edge elements.

Returns: Integer value with the number of properties.

Implements te::graph::AbstractGraph.

◆ getMetadata()

virtual te::graph::GraphMetadata * te::graph::Graph::getMetadata ( )

virtual

Function used to access the graph metadata.

Returns: A pointer to a class that defines the graph metadata

Implements te::graph::AbstractGraph.

◆ getVertex()

virtual te::graph::Vertex * te::graph::Graph::getVertex ( int id )

virtual

It returns the vertex element if it's exist.

Parameters

id	Vertex identification

Returns: A valid vertex point if the element was found and a null pointer in other case.

Implements te::graph::AbstractGraph.

◆ getVertexProperty()

virtual te::dt::Property * te::graph::Graph::getVertexProperty ( int idx )

virtual

Get a vertex property given a index.

Parameters

idx	Index of the property

Returns: A property associated to the vertex element if the index is right and a null pointer in other case.

Implements te::graph::AbstractGraph.

◆ getVertexPropertySize()

virtual int te::graph::Graph::getVertexPropertySize ( )

virtual

Used to verify the number of properties associated to vertex elements.

Returns: Integer value with the number of properties.

Implements te::graph::AbstractGraph.

◆ removeEdge()

virtual void te::graph::Graph::removeEdge ( int id )

virtual

This function removes the edge element from graph, also was removed in data source.

Parameters

id	Edge identification

Implements te::graph::AbstractGraph.

Reimplemented in te::graph::BidirectionalGraph, te::graph::DirectedGraph, and te::graph::UndirectedGraph.

◆ removeEdgeProperty()

virtual void te::graph::Graph::removeEdgeProperty ( int idx )

virtual

Remove a property associated to the edge element.

Parameters

idx	Index of the property

Implements te::graph::AbstractGraph.

◆ removeVertex()

virtual void te::graph::Graph::removeVertex ( int id )

virtual

This function removes the vertex element from graph, also was removed in data source.

Parameters

id	Vertex identification

Implements te::graph::AbstractGraph.

◆ removeVertexProperty()

virtual void te::graph::Graph::removeVertexProperty ( int idx )

virtual

Remove a property associated to the vertex element.

Parameters

idx	Index of the property

Implements te::graph::AbstractGraph.

◆ update() [1/2]

virtual void te::graph::Graph::update ( Edge * e )

virtual

Update the edge element.

Parameters

e	Edge element

Note: This function turns the dirty flag of current GraphData to true and also the dirty flag of the edge.

Implements te::graph::AbstractGraph.

◆ update() [2/2]

virtual void te::graph::Graph::update ( Vertex * v )

virtual

Update the vertex element.

Parameters

v	Vertex element

Note: This function turns the dirty flag of current GraphData to true and also the dirty flag of the vertex.

Implements te::graph::AbstractGraph.

Member Data Documentation

◆ m_dataManager

GraphDataManager* te::graph::Graph::m_dataManager

protected

Used to load and save GraphData information from a DataSource.

Definition at line 290 of file Graph.h.

◆ m_graphCache

GraphCache* te::graph::Graph::m_graphCache

protected

Class used to keep all graph data loaded.

Definition at line 292 of file Graph.h.

◆ m_graphData

GraphData* te::graph::Graph::m_graphData

This class has the graph data and properties.

Definition at line 298 of file Graph.h.

◆ m_metadata

GraphMetadata* te::graph::Graph::m_metadata

protected

Graph Data loader strategy.

Definition at line 294 of file Graph.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/graph/graphs/Graph.h

Public Member Functions

Edge Access Methods

Detailed Description

Constructor & Destructor Documentation

◆ Graph() [1/3]

◆ Graph() [2/3]

◆ Graph() [3/3]

◆ ~Graph()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ addEdgeProperty()

◆ addVertexProperty()

◆ flush()

◆ getEdge()

◆ getEdgeProperty()

◆ getEdgePropertySize()

◆ getMetadata()

◆ getVertex()

◆ getVertexProperty()

◆ getVertexPropertySize()

◆ removeEdge()

◆ removeEdgeProperty()

◆ removeVertex()

◆ removeVertexProperty()

◆ update() [1/2]

◆ update() [2/2]

Member Data Documentation

◆ m_dataManager

◆ m_graphCache

◆ m_graphData

◆ m_metadata