This class defines a commun interface to represents a graph iterator class. The main diferency to anothers iterators is the possibility to iterate over the edges or vertexs from a graph. More...

#include <BoxIterator.h>

Inheritance diagram for te::graph::BoxIterator:

Public Member Functions
	BoxIterator (te::graph::AbstractGraph *g)
	Default constructor. More...

	BoxIterator (te::graph::AbstractGraph g, te::gm::Envelope e)
	Constructor. More...

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

Vertex Access Methods
Method used to access vertex elements from a graph.
te::gm::Envelope *	m_extent

virtual te::graph::Vertex *	getFirstVertex ()
	It returns a pointer to the first vertex element of a graph. More...

virtual te::graph::Edge *	getFirstEdge ()
	It returns a pointer to the first edge element of a graph. More...

Vertex Iterator Methods
Method used to access vertex elements from a graph.
te::graph::AbstractGraph *	m_graph
	Pointer to a abstract graph used to access the elements. More...

std::unique_ptr< te::da::DataSet >	m_vertexQuery
	Attribute used to keep the vertex iterator. More...

std::unique_ptr< te::da::DataSet >	m_edgeQuery
	Attribute used to keep the edge iterator. More...

bool	m_listIsolatedVertex
	Flag used to indicated that the isolated vertex will be listed. More...

virtual te::graph::Vertex *	getNextVertex ()
	It returns a pointer to the next vertex element of a graph. More...

virtual te::graph::Vertex *	getPreviousVertex ()
	It returns a pointer to the previous vertex element of a graph. More...

virtual bool	isVertexIteratorAfterEnd ()
	Used to check the iterator position. More...

virtual size_t	getVertexInteratorCount ()
	It returns the number of elements of this iterator. More...

void	listIsolatedVertex (bool flag)
	Used to set that the isolated vertex must be listed. More...

virtual te::graph::Edge *	getNextEdge ()
	It returns a pointer to the next edge element of a graph. More...

virtual te::graph::Edge *	getPreviousEdge ()
	It returns a pointer to the previous edge element of a graph. More...

virtual bool	isEdgeIteratorAfterEnd ()
	Used to check the iterator position. More...

virtual size_t	getEdgeInteratorCount ()
	It returns the number of elements of this iterator. More...

Detailed Description

This class defines a commun interface to represents a graph iterator class. The main diferency to anothers iterators is the possibility to iterate over the edges or vertexs from a graph.

The box strategy is used select a restrict area in a graph and a iterator will be create accessing all elements inside this area.

See also: AbstractIterator

Definition at line 71 of file BoxIterator.h.

Constructor & Destructor Documentation

◆ BoxIterator() [1/2]

te::graph::BoxIterator::BoxIterator ( te::graph::AbstractGraph * g )

Default constructor.

Parameters

g	Pointer to a valid graph implementation

◆ BoxIterator() [2/2]

te::graph::BoxIterator::BoxIterator	(	te::graph::AbstractGraph *	g,
		te::gm::Envelope *	e
	)

Constructor.

Parameters

g	Pointer to a valid graph implementation
e	Object used to define a restrict area

◆ ~BoxIterator()

virtual te::graph::BoxIterator::~BoxIterator ( )

virtual

Virtual destructor.

Member Function Documentation

◆ getEdgeInteratorCount()

virtual size_t te::graph::AbstractIterator::getEdgeInteratorCount ( )

virtualinherited

It returns the number of elements of this iterator.

Returns: Size t value.

Reimplemented in te::graph::MemoryIterator.

◆ getFirstEdge()

virtual te::graph::Edge* te::graph::BoxIterator::getFirstEdge ( )

virtual

It returns a pointer to the first edge element of a graph.

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

Implements te::graph::AbstractIterator.

◆ getFirstVertex()

virtual te::graph::Vertex* te::graph::BoxIterator::getFirstVertex ( )

virtual

It returns a pointer to the first vertex element of a graph.

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

Implements te::graph::AbstractIterator.

◆ getNextEdge()

virtual te::graph::Edge* te::graph::AbstractIterator::getNextEdge ( )

virtualinherited

It returns a pointer to the next edge element of a graph.

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

Reimplemented in te::graph::MemoryIterator.

◆ getNextVertex()

virtual te::graph::Vertex* te::graph::AbstractIterator::getNextVertex ( )

virtualinherited

It returns a pointer to the next vertex element of a graph.

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

Reimplemented in te::graph::MemoryIterator.

◆ getPreviousEdge()

virtual te::graph::Edge* te::graph::AbstractIterator::getPreviousEdge ( )

virtualinherited

It returns a pointer to the previous edge element of a graph.

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

Reimplemented in te::graph::MemoryIterator.

◆ getPreviousVertex()

virtual te::graph::Vertex* te::graph::AbstractIterator::getPreviousVertex ( )

virtualinherited

It returns a pointer to the previous vertex element of a graph.

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

Reimplemented in te::graph::MemoryIterator.

◆ getVertexInteratorCount()

virtual size_t te::graph::AbstractIterator::getVertexInteratorCount ( )

virtualinherited

It returns the number of elements of this iterator.

Returns: Size t value.

Reimplemented in te::graph::MemoryIterator.

◆ isEdgeIteratorAfterEnd()

virtual bool te::graph::AbstractIterator::isEdgeIteratorAfterEnd ( )

virtualinherited

Used to check the iterator position.

Returns: True if the iterator is at after the end and false in other case

Reimplemented in te::graph::MemoryIterator.

◆ isVertexIteratorAfterEnd()

virtual bool te::graph::AbstractIterator::isVertexIteratorAfterEnd ( )

virtualinherited

Used to check the iterator position.

Returns: True if the iterator is at after the end and false in other case

Reimplemented in te::graph::MemoryIterator.

◆ listIsolatedVertex()

void te::graph::AbstractIterator::listIsolatedVertex ( bool flag )

inherited

Used to set that the isolated vertex must be listed.

Parameters

flag	Flag used to set.

Member Data Documentation

◆ m_edgeQuery

std::unique_ptr<te::da::DataSet> te::graph::AbstractIterator::m_edgeQuery

protectedinherited

Attribute used to keep the edge iterator.

Definition at line 168 of file AbstractIterator.h.

◆ m_extent

te::gm::Envelope* te::graph::BoxIterator::m_extent

protected

Definition at line 118 of file BoxIterator.h.

◆ m_graph

te::graph::AbstractGraph* te::graph::AbstractIterator::m_graph

protectedinherited

Pointer to a abstract graph used to access the elements.

Definition at line 165 of file AbstractIterator.h.

◆ m_listIsolatedVertex

bool te::graph::AbstractIterator::m_listIsolatedVertex

protectedinherited

Flag used to indicated that the isolated vertex will be listed.

Definition at line 170 of file AbstractIterator.h.

◆ m_vertexQuery

std::unique_ptr<te::da::DataSet> te::graph::AbstractIterator::m_vertexQuery

protectedinherited

Attribute used to keep the vertex iterator.

Definition at line 167 of file AbstractIterator.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/graph/iterator/BoxIterator.h

Public Member Functions

Vertex Access Methods

Vertex Iterator Methods

Detailed Description

Constructor & Destructor Documentation

◆ BoxIterator() [1/2]

◆ BoxIterator() [2/2]

◆ ~BoxIterator()

Member Function Documentation

◆ getEdgeInteratorCount()

◆ getFirstEdge()

◆ getFirstVertex()

◆ getNextEdge()

◆ getNextVertex()

◆ getPreviousEdge()

◆ getPreviousVertex()

◆ getVertexInteratorCount()

◆ isEdgeIteratorAfterEnd()

◆ isVertexIteratorAfterEnd()

◆ listIsolatedVertex()

Member Data Documentation

◆ m_edgeQuery

◆ m_extent

◆ m_graph

◆ m_listIsolatedVertex

◆ m_vertexQuery