Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - Core - Graphs - GraphNodeBaseC
 

  PUBLIC
GraphNodeBaseC::GraphNodeBaseC(GraphBaseBodyC &)
GraphNodeBaseC::GraphNodeBaseC(const GraphNodeBaseC &)
GraphNodeBaseC::GraphNodeBaseC(const IntrDLIterC &)
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::GraphNodeBaseC(void)
GraphNodeBaseC::ID(void) const
GraphNodeBaseC::GraphNodeBaseC(GraphNodeBaseBodyC &,IntrDListC &)
GraphNodeBaseC::GraphNodeBaseC(GraphNodeBaseBodyC &,GraphBaseBodyC &)
GraphNodeBaseC::GraphNodeBaseC(GraphNodeBaseBodyC &,GraphBaseC &)
GraphNodeBaseC::Graph(void)
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)
IntrDLIterC::SetIter(const IntrDListC &,DataT &)
IntrDLIterC::Head(void)
IntrDLIterC::Head(void) const

   GraphNodeBaseC   
 
Graph node handle.
 
include "Ravl/GraphBase.hh"
Created:22/8/1994 
Source file:Ravl/Core/Container/Graph/GraphBase.hh
User Level:Develop
Library:RavlCore
In Scope:RavlN

Comments:
This class also serves as an iterator of the list of graph nodes.

Parent Classes: Derived Classes: Methods:
GraphNodeBaseC(GraphBaseBodyC & graph)
Creates the node iterator of the 'graph'. The iterator will point to the first node in the node list of the graph.

GraphNodeBaseC(const GraphNodeBaseC & node)
Copy constructor.

GraphNodeBaseC(const IntrDLIterC<GraphNodeBaseBodyC> & it)
Base class constructor.

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.

GraphNodeBaseC()
The default constructor used by constructors of arrays. It constructs the unvalid object which must be initialized by the member function LateItemSet().

UIntT ID() const
Access edge id.

GraphNodeBaseC(GraphNodeBaseBodyC & node,IntrDListC<GraphNodeBaseBodyC> & list)
Creates the iterator of graph nodes which points to the 'node'.

GraphNodeBaseC(GraphNodeBaseBodyC & aNode,GraphBaseBodyC & bg)
Creates the iterator of graph nodes which points to the 'node'.

GraphNodeBaseC(GraphNodeBaseBodyC & aNode,GraphBaseC & bg)
Creates the iterator of graph nodes which points to the 'node'.

GraphBaseBodyC & Graph()
Returns the whole graph.

#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.

void SetIter(const IntrDListC<GraphNodeBaseBodyC> & lst,GraphNodeBaseBodyC & nplace)
Set iterator to new value.

DLinkC & Head()
Get head of list.

const DLinkC & Head() const
Get head of list.


Maintainer:Radek Marik, Created: 22/8/1994, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002