libgexf  0.1.3
Public Member Functions | List of all members
libgexf::EdgeIter Class Reference

Iterator on edges. More...

#include <edgeiter.h>

Inheritance diagram for libgexf::EdgeIter:
libgexf::AbstractIter

Public Member Functions

 EdgeIter (const libgexf::Graph *g)
 Constructor. More...
 
EdgeIterbegin ()
 Init. More...
 
bool hasNext () const
 Test next element in collection. More...
 
libgexf::t_id next ()
 Iterate. More...
 
libgexf::t_id currentSource () const
 Get source node. More...
 
libgexf::t_id currentTarget () const
 Get target node. More...
 
float currentProperty (libgexf::t_edge_property prop) const
 Get topological property value. More...
 

Detailed Description

Iterator on edges.

Constructor & Destructor Documentation

◆ EdgeIter()

libgexf::EdgeIter::EdgeIter ( const libgexf::Graph g)
explicit

Constructor.

Parameters
g: Reference to the Graph object

Member Function Documentation

◆ begin()

EdgeIter * libgexf::EdgeIter::begin ( )
virtual

Init.

Initialize (or re-initialize) the iterator.

Returns
an instance of the iterator

Implements libgexf::AbstractIter.

◆ currentProperty()

float libgexf::EdgeIter::currentProperty ( libgexf::t_edge_property  prop) const

Get topological property value.

Parameters
prop: Topological edge property name
Returns
Property value or 0.0 by default

◆ currentSource()

t_id libgexf::EdgeIter::currentSource ( ) const

Get source node.

Returns
The node id of the source

◆ currentTarget()

t_id libgexf::EdgeIter::currentTarget ( ) const

Get target node.

Returns
The node id of the target

◆ hasNext()

bool libgexf::EdgeIter::hasNext ( ) const
virtual

Test next element in collection.

Verify if another element exists.

Returns
true if another element exists, false otherwise.

Implements libgexf::AbstractIter.

◆ next()

t_id libgexf::EdgeIter::next ( )
virtual

Iterate.

Get next element in collection.

Returns
The edge ID.

Implements libgexf::AbstractIter.


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