User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
Ravl - Core - Graphs - GraphNodeIterC<class NodeT,class EdgeT>
 

  PUBLIC
GraphNodeIterC::GraphNodeIterC(GraphC &)
GraphNodeIterC::GraphNodeIterC(void)
GraphNodeIterC::GraphNodeIterC(const GraphNodeIterC &)
GraphNodeIterC::~GraphNodeIterC(void)
GraphNodeIterC::operator =(const GraphNodeIterC &)
GraphNodeIterC::operator ==(const GraphNodeIterC &) const
GraphNodeIterC::operator !=(const GraphNodeIterC &) const
GraphNodeIterC::Data(void)
GraphNodeIterC::Data(void) const
GraphNodeIterC::In(void)
GraphNodeIterC::Out(void)
GraphNodeIterC::Invalidate(void)
GraphNodeIterC::Del(void)
GraphNodeIterC::DelMoveNext(void)
GraphNodeIterC::IsNodeValid(void) const
GraphNodeIterC::IsIterValid(void) const
GraphNodeBaseC::operator ==(const GraphNodeBaseC &) const
GraphNodeBaseC::Hash(void) const
GraphNodeBaseC::NodeRep(void)
GraphNodeBaseC::NodeRep(void) const
GraphNodeBaseC::In(void)
GraphNodeBaseC::Out(void)
GraphNodeBaseC::Del(void)
GraphNodeBaseC::ID(void) const
IntrDLIterC::IsValid(void) const
IntrDLIterC::First(void)
IntrDLIterC::Last(void)
IntrDLIterC::operator bool(void) const
IntrDLIterC::IsElm(void) const
IntrDLIterC::IsFirst(void) const
IntrDLIterC::IsLast(void) const
IntrDLIterC::operator ++(void)
IntrDLIterC::operator ++(int)
IntrDLIterC::operator --(int)
IntrDLIterC::Next(void)
IntrDLIterC::Prev(void)
IntrDLIterC::NextCrc(void)
IntrDLIterC::PrevCrc(void)
IntrDLIterC::operator *(void)
IntrDLIterC::operator *(void) const
IntrDLIterC::operator ->(void)
IntrDLIterC::operator ->(void) const
IntrDLIterC::Data(void)
IntrDLIterC::Data(void) const
IntrDLIterC::Extract(void)
IntrDLIterC::Del(void)
IntrDLIterC::InsertBef(DataT &)
IntrDLIterC::InsertAft(DataT &)
IntrDLIterC::List(void)
IntrDLIterC::List(void) const
IntrDLIterC::Invalidate(void)

   GraphNodeIterC<class NodeT,class EdgeT>   
 
Node iterator.
 
include "Ravl/GraphNode.hh"
Created:10/12/1996 
User Level:Normal
Library:RavlCore
Example:exGraph.cc
In Scope:RavlN

Comments:
Iterates through all the nodes in a graph.

Parent Classes: Methods:
GraphNodeIterC(GraphC<NodeT,EdgeT> & AGraph)
Constructor.

GraphNodeIterC()
Default constructor.

GraphNodeIterC(const GraphNodeIterC<NodeT,EdgeT> & Another)
Copy constructor.

~GraphNodeIterC()
Destructor.

const GraphNodeIterC<NodeT,EdgeT> & operator =(const GraphNodeIterC<NodeT,EdgeT> & Oth)
Assigment.

bool operator ==(const GraphNodeIterC<NodeT,EdgeT> & Oth) const
Comparison.

bool operator !=(const GraphNodeIterC<NodeT,EdgeT> & Oth) const
Comparison.

NodeT & Data(void)
Access data.

const NodeT & Data(void) const
Access data.

GraphAdjIterC<NodeT,EdgeT> In()
Returns the iterator that is set to the first item of the list of the graph adjacencies in which this node is the target node.

GraphAdjIterC<NodeT,EdgeT> Out()
Returns the iterator that is set to the first item of the list of the graph adjacencies in which this node is the source node.

void Invalidate()
Invalidate handle, IsValid() will return false after this call until the handle is assigmed to another node.

void Del()
Unlinks edge from the graph and deletes it. The iterator will point to the previous edge in the graph edge list.

void DelMoveNext()
Unlinks edge from the graph and deletes it. The iterator will point to the next edge in the graph edge list.

bool IsNodeValid() const

bool IsIterValid() const

#include "Ravl/GraphBase.hh"
bool operator ==(const GraphNodeBaseC & Oth) const
True when both iterators are pointing at the same node.

UIntT Hash(void) const
Returns a hash value for the current node.

GraphNodeBaseBodyC & NodeRep()
Returns the node.

const GraphNodeBaseBodyC & NodeRep() const
Returns the node.

GraphAdjIterBaseC In()
Returns the iterator that is set to the first item of the list of the graph adjacencies in which this node is the target node.

GraphAdjIterBaseC Out()
Returns the iterator that is set to the first item of the list of the graph adjacencies in which this node is the source node.

void Del()
Unlinks the node from the graph and deletes it. The iterator will point to the previous node in the graph node list.

UIntT ID() const
Access edge id.

#include "Ravl/InDLIter.hh"
bool IsValid() const
Is iterator valid ?
true is returned for a valid iterator.

void First()
Goto first element in the list.

void Last()
Goto the last element in the list.

operator bool() const
At a valid node ?

bool IsElm() const
At a valid element in the list ?
AMMA compatibilty function, use operator bool() instread.

bool IsFirst() const
At the first element in the list ?
AMMA compatibilty function.

bool IsLast() const
At the last element in the list ?
AMMA compatibilty function.

void operator ++()
Goto next element in list.

void operator ++(int)
Goto next element in list.

void operator --(int)
Goto previous element in list.

void Next()
Goto next element in list.
AMMA compatibilty function, use operator++() instread.

void Prev()
Goto previous element in list.
AMMA compatibilty function, use operator--() instread.

void NextCrc()
Goto next element in list, skip the head element.
AMMA compatibilty function.

void PrevCrc()
Goto previous element in list, skip the head element.
AMMA compatibilty function.

GraphNodeBaseBodyC & operator *()
Access data.
NB. The iterator MUST be valid. check with 'operator bool()'.

const GraphNodeBaseBodyC & operator *() const
Constant access to data.
NB. The iterator MUST be valid. check with 'operator bool()'.

GraphNodeBaseBodyC * operator ->()
Access data.
NB. The iterator MUST be valid. check with 'operator bool()'.

const GraphNodeBaseBodyC * operator ->() const
Constant access to data.
NB. The iterator MUST be valid. check with 'operator bool()'.

GraphNodeBaseBodyC & Data()
Access data.
NB. The iterator MUST be valid. check with 'operator bool()'.

const GraphNodeBaseBodyC & Data() const
Constant access to data.
NB. The iterator MUST be valid. check with 'operator bool()'.

GraphNodeBaseBodyC & Extract()
Extract the current element from the list.
Do not delete it, the user is responsible for ensuring this happens at an approprate time. The iteration is left pointing at the element before the one extracted. The iterator must be valid.

void Del()
Delete the current element from the list.
actuall delete the element where appropriate. The iterator must be valid.

void InsertBef(GraphNodeBaseBodyC & dat)
Insert data before current element.
if at the head of the list (i.e. operator bool() failes.) then add at end.

void InsertAft(GraphNodeBaseBodyC & dat)
Insert data after current element.
if at the head of the list (i.e. operator bool() failes.) then add at begining.

IntrDListC<GraphNodeBaseBodyC> & List()
Access the list we're iterating.

const IntrDListC<GraphNodeBaseBodyC> & List() const
Access the list we're iterating.

bool Invalidate()
Point interator at an invalid element.


Maintainer:Charles Galambos, Created: 10/12/1996, Documentation by CxxDoc: Tue Aug 13 09:59:02 2002