ggl::RightSidePattern::EdgeDescriptor Class Reference

#include <RuleGraph.hh>

Inheritance diagram for ggl::RightSidePattern::EdgeDescriptor:

Public Member Functions
virtual EdgeDescriptor *	clone () const
	EdgeDescriptor (const Rule::CoreGraph::out_edge_iterator &cur_edge, const Rule::CoreGraph::out_edge_iterator &neigh_end, const RightSidePattern &parent)
virtual const std::string &	getEdgeLabel (void) const
bool	operator!= (const EdgeDescriptor &ed) const
bool	operator!= (const Graph_Interface::EdgeDescriptor &ed) const
virtual EdgeDescriptor &	operator++ ()
bool	operator== (const EdgeDescriptor &ed) const
virtual	~EdgeDescriptor ()
	Destruction. More...

Protected Attributes
Rule::CoreGraph::out_edge_iterator	cur_edge
Rule::CoreGraph::out_edge_iterator	list_end
const RightSidePattern &	parent
	access to the parent instance for fast graph access More...

Detailed Description

Special edge descriptor to enable the iteration over the edges contained in the internally used boost graph instance.

Definition at line 338 of file RuleGraph.hh.

Constructor & Destructor Documentation

ggl::RightSidePattern::EdgeDescriptor::EdgeDescriptor	(	const Rule::CoreGraph::out_edge_iterator &	cur_edge,
		const Rule::CoreGraph::out_edge_iterator &	neigh_end,
		const RightSidePattern &	parent
	)

Construction of a new edge descriptor given the our edge iterators

Parameters

cur_edge	the current boost edge iterator
neigh_end	the end of the edge iteration
parent	access to the parent instance for graph access

virtual ggl::RightSidePattern::EdgeDescriptor::~EdgeDescriptor ( )

virtual

Member Function Documentation

virtual EdgeDescriptor* ggl::RightSidePattern::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

virtual const std::string& ggl::RightSidePattern::EdgeDescriptor::getEdgeLabel ( void  ) const

virtual

Access to the label of the edge.

Returns

the edge label

bool ggl::RightSidePattern::EdgeDescriptor::operator!=

(

const EdgeDescriptor &

ed

)

const

Inequality comparison

Parameters

ed	the edge to compare to

Returns

true if both descriptors describe different edges

bool ggl::RightSidePattern::EdgeDescriptor::operator!=

(

const Graph_Interface::EdgeDescriptor &

ed

)

const

Inequality comparison

Parameters

ed	the edge to compare to

Returns

true if both descriptors describe different edges

virtual EdgeDescriptor& ggl::RightSidePattern::EdgeDescriptor::operator++ ( )

virtual

Iterator support

Returns

the next EdgeDescriptor in the adjacency

bool ggl::RightSidePattern::EdgeDescriptor::operator==

(

const EdgeDescriptor &

ed

)

const

Equality comparison

Parameters

ed	the edge to compare to

Returns

true if both descriptors describe the same edge

Field Documentation

Rule::CoreGraph::out_edge_iterator ggl::RightSidePattern::EdgeDescriptor::cur_edge

protected

the out edge iterator of the current target node within the local adjacency list

Definition at line 346 of file RuleGraph.hh.

Rule::CoreGraph::out_edge_iterator ggl::RightSidePattern::EdgeDescriptor::list_end

protected

the edge iterator that marks the end of the local adjacency list

Definition at line 349 of file RuleGraph.hh.

const RightSidePattern& ggl::RightSidePattern::EdgeDescriptor::parent

protected

Definition at line 352 of file RuleGraph.hh.

---

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

• src/ggl/RuleGraph.hh