sgm::Graph_Interface::OutEdge_iterator Class Reference

#include <Graph_Interface.hh>

Public Member Functions
bool	operator!= (const OutEdge_iterator &it) const
const EdgeDescriptor &	operator* () const
OutEdge_iterator &	operator++ ()
	Prefix increment (++I) to next element. More...
OutEdge_iterator	operator++ (int)
	Postfix increment (I++) to next element. More...
const EdgeDescriptor *const	operator-> () const
OutEdge_iterator &	operator= (const OutEdge_iterator &toCopy)
bool	operator== (const OutEdge_iterator &it) const
	OutEdge_iterator ()
	Default construction. More...
	OutEdge_iterator (const EdgeDescriptor &data)
	OutEdge_iterator (const OutEdge_iterator &toCopy)
	~OutEdge_iterator ()
	Destruction. More...

Protected Attributes
std::auto_ptr< EdgeDescriptor >	data

Detailed Description

Generic constant iterator class to enumerate the outgoing edges for a given node. For each out edge an EdgeDescriptor instance is provided.

Definition at line 103 of file Graph_Interface.hh.

Constructor & Destructor Documentation

sgm::Graph_Interface::OutEdge_iterator::OutEdge_iterator

(

)

sgm::Graph_Interface::OutEdge_iterator::OutEdge_iterator

(

const EdgeDescriptor &

data

)

Construction from data

Parameters

data	the EdgeDescriptor data to use

sgm::Graph_Interface::OutEdge_iterator::OutEdge_iterator

(

const OutEdge_iterator &

toCopy

)

Copy construction

Parameters

toCopy

the object to make this iterator a copy of

sgm::Graph_Interface::OutEdge_iterator::~OutEdge_iterator

(

)

Member Function Documentation

bool sgm::Graph_Interface::OutEdge_iterator::operator!=

(

const OutEdge_iterator &

it

)

const

Inequality comparison

Returns

true if both iterators are NOT pointing to the same edge

const EdgeDescriptor& sgm::Graph_Interface::OutEdge_iterator::operator*

(

)

const

access to the descriptive data of the current edge

Returns

the current edge data

OutEdge_iterator& sgm::Graph_Interface::OutEdge_iterator::operator++

(

)

OutEdge_iterator sgm::Graph_Interface::OutEdge_iterator::operator++

(

int

)

const EdgeDescriptor* const sgm::Graph_Interface::OutEdge_iterator::operator->

(

)

const

access to the descriptive data of the current edge

Returns

the current edge data

OutEdge_iterator& sgm::Graph_Interface::OutEdge_iterator::operator=

(

const OutEdge_iterator &

toCopy

)

Assign to the given iterator

Parameters

toCopy

the object to make this iterator a copy of

bool sgm::Graph_Interface::OutEdge_iterator::operator==

(

const OutEdge_iterator &

it

)

const

Equality comparison

Returns

true if both iterators are pointing to the same edge

Field Documentation

std::auto_ptr< EdgeDescriptor > sgm::Graph_Interface::OutEdge_iterator::data

protected

the data object to be used for iteration. Note: the object can be also any subclass of EdgeDescriptor.

Definition at line 108 of file Graph_Interface.hh.

---

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

• src/sgm/Graph_Interface.hh