sgm::SubGraph::EdgeDescriptor Class Reference

#include <SubGraph.hh>

Inheritance diagram for sgm::SubGraph::EdgeDescriptor:

Public Member Functions
virtual EdgeDescriptor *	clone () const
	EdgeDescriptor (const Graph_Interface::OutEdge_iterator &curEdge, const Graph_Interface::OutEdge_iterator &edgeEnd, const SubGraph &parent)
virtual const std::string &	getEdgeLabel (void) const
const Graph_Interface::IndexType &	getFromIndex (void) const
const Graph_Interface::IndexType &	getToIndex (void) const
virtual bool	operator!= (const EdgeDescriptor &ed) const
virtual bool	operator!= (const Graph_Interface::EdgeDescriptor &ed) const
virtual EdgeDescriptor &	operator++ ()
virtual bool	operator== (const EdgeDescriptor &ed) const
virtual bool	operator== (const EdgeDescriptor &ed) const
virtual	~EdgeDescriptor ()
	Destruction. More...

Protected Attributes
OutEdge_iterator	curEdge
	the iterator to the current edge More...
OutEdge_iterator	edgeEnd
	the iterator to the edge iteration end More...
Graph_Interface::IndexType	from
	the source of the edge described More...
const SubGraph &	parent
	access to the parent class for full subgraph information More...
Graph_Interface::IndexType	to
	the target of the edge described More...

Detailed Description

Special edge descriptor to enable the iteration over the edges covered by this subgraph.

Definition at line 31 of file SubGraph.hh.

Constructor & Destructor Documentation

sgm::SubGraph::EdgeDescriptor::EdgeDescriptor	(	const Graph_Interface::OutEdge_iterator &	curEdge,
		const Graph_Interface::OutEdge_iterator &	edgeEnd,
		const SubGraph &	parent
	)

Construction

Parameters

curEdge	the iterator to the current edge
edgeEnd	the iterator to the iteration end
parent	access to the parent full graph information

virtual sgm::SubGraph::EdgeDescriptor::~EdgeDescriptor ( )

virtual

Reimplemented from sgm::Graph_Interface::EdgeDescriptor.

Member Function Documentation

virtual EdgeDescriptor* sgm::SubGraph::EdgeDescriptor::clone ( ) const

virtual

Create a heap copy of this object. NOTE: this has to be removed by the calling function.

Returns

a new heap copy of this object

Implements sgm::Graph_Interface::EdgeDescriptor.

virtual const std::string& sgm::SubGraph::EdgeDescriptor::getEdgeLabel ( void  ) const

virtual

Access to the label of the edge.

Returns

the edge label

Implements sgm::Graph_Interface::EdgeDescriptor.

const Graph_Interface::IndexType& sgm::Graph_Interface::EdgeDescriptor::getFromIndex ( void  ) const

inherited

Access to the source of the edge.

Returns

the global source node index

const Graph_Interface::IndexType& sgm::Graph_Interface::EdgeDescriptor::getToIndex ( void  ) const

inherited

Access to the target of the edge.

Returns

the global target node index

virtual bool sgm::SubGraph::EdgeDescriptor::operator!= ( const EdgeDescriptor &  ed ) const

virtual

Inequality comparison

Parameters

ed	the edge to compare to

Returns

true if both descriptors describe different edges

virtual bool sgm::SubGraph::EdgeDescriptor::operator!= ( const Graph_Interface::EdgeDescriptor &  ed ) const

virtual

Inequality comparison

Parameters

ed	the edge to compare to

Returns

true if both descriptors describe different edges

Implements sgm::Graph_Interface::EdgeDescriptor.

virtual EdgeDescriptor& sgm::SubGraph::EdgeDescriptor::operator++ ( )

virtual

Iterator support

Returns

the next EdgeDescriptor in the adjacency

Implements sgm::Graph_Interface::EdgeDescriptor.

virtual bool sgm::SubGraph::EdgeDescriptor::operator== ( const EdgeDescriptor &  ed ) const

virtual

Equality comparison

Parameters

ed	the edge to compare to

Returns

true if both descriptors describe the same edge

virtual bool sgm::Graph_Interface::EdgeDescriptor::operator== ( const EdgeDescriptor &  ed ) const

virtualinherited

Equality comparison

Parameters

ed	the edge to compare to

Returns

true if both descriptors describe the same edge

Field Documentation

OutEdge_iterator sgm::SubGraph::EdgeDescriptor::curEdge

protected

Definition at line 40 of file SubGraph.hh.

OutEdge_iterator sgm::SubGraph::EdgeDescriptor::edgeEnd

protected

Definition at line 42 of file SubGraph.hh.

Graph_Interface::IndexType sgm::Graph_Interface::EdgeDescriptor::from

protectedinherited

Definition at line 53 of file Graph_Interface.hh.

const SubGraph& sgm::SubGraph::EdgeDescriptor::parent

protected

Definition at line 44 of file SubGraph.hh.

Graph_Interface::IndexType sgm::Graph_Interface::EdgeDescriptor::to

protectedinherited

Definition at line 55 of file Graph_Interface.hh.

---

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

• src/sgm/SubGraph.hh