Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Compound Members  

VariableNodeIterator Class Template Reference
[NodeIterator]

#include <nodeiterator.h>

Inheritance diagram for VariableNodeIterator:

Inheritance graph
[legend]
Collaboration diagram for VariableNodeIterator:

Collaboration graph
[legend]
List of all members.

Public Types

typedef VariableNodeIterator<
_Node > 
iterator
typedef VariableNodeIterator<
const _Node > 
const_iterator
typedef VariableNodeIterator<
_Node, _Ref, _Ptr > 
_Self
typedef NodeIterator< _Node,
_Ref, _Ptr > 
_Base

Public Methods

 VariableNodeIterator ()
 VariableNodeIterator (_Node *start)
 Construct a VariableNodeIterator beginning at the given Node.

virtual _Self * construct () const
virtual _Self * clone (_Node *start=0) const
 Copy constructor.

virtual ~VariableNodeIterator ()
virtual void setStart (_Node *start)
 Set start node for next iteration.

virtual bool operator== (const _Self &rhs)
 Equality operator.

virtual bool operator!= (const _Self &rhs)
 Inequality operator.

virtual _Self & operator++ ()
 Prefix proceed operator.


Detailed Description

template<class _Node, class _Ref = _Node&, class _Ptr = _Node*>
class treecomp::VariableNodeIterator< _Node, _Ref, _Ptr >

This iterator iterates over all nodes that belong to a given node (have the same root) and are not fixed. It doesn't iterate over subtree nodes. The default constructor makes a 'past the end VariableNodeIterator'

Definition at line 168 of file nodeiterator.h.


Member Typedef Documentation

typedef NodeIterator<_Node,_Ref,_Ptr> _Base
 

Definition at line 174 of file nodeiterator.h.

typedef VariableNodeIterator<_Node, _Ref,_Ptr> _Self
 

Reimplemented from NodeIterator.

Definition at line 173 of file nodeiterator.h.

Referenced by VariableNodeIterator::clone(), and VariableNodeIterator::construct().

typedef VariableNodeIterator<const _Node > const_iterator
 

Reimplemented from NodeIterator.

Definition at line 172 of file nodeiterator.h.

typedef VariableNodeIterator<_Node> iterator
 

Reimplemented from NodeIterator.

Definition at line 171 of file nodeiterator.h.


Constructor & Destructor Documentation

VariableNodeIterator (    )  [inline]
 

Definition at line 177 of file nodeiterator.h.

VariableNodeIterator (  _Node *    start )  [inline]
 

Construct a VariableNodeIterator beginning at the given Node.

Parameters:
start  The Node to start at

Definition at line 180 of file nodeiterator.h.

References VariableNodeIterator::setStart().

virtual ~VariableNodeIterator (    )  [inline, virtual]
 

Definition at line 183 of file nodeiterator.h.


Member Function Documentation

VariableNodeIterator< _Node, _Ref, _Ptr >::_Self * clone (  _Node *    start = 0 )  const [virtual]
 

Copy constructor.

Parameters:
start  Node to start with (if not given make identical copy)

Reimplemented from NodeIterator.

Definition at line 496 of file nodeiterator.h.

References VariableNodeIterator::_Self.

virtual _Self* construct (    )  const [inline, virtual]
 

Reimplemented from NodeIterator.

Definition at line 181 of file nodeiterator.h.

References VariableNodeIterator::_Self.

bool operator!= (  const _Self &    rhs )  [virtual]
 

Inequality operator.

Warning:
Compares only 'past the end'

Reimplemented from NodeIterator.

Definition at line 521 of file nodeiterator.h.

References NodeIterator::isEnd().

VariableNodeIterator< _Node, _Ref, _Ptr >::_Self & operator++ (    )  [virtual]
 

Prefix proceed operator.

Reimplemented from NodeIterator.

Definition at line 532 of file nodeiterator.h.

References NodeIterator::addToNodeList(), NodeIterator::m_currentNode, NodeIterator::m_nodeList, NodeIterator::m_root, and NodeIterator::setEnd().

Referenced by VariableNodeIterator::setStart().

bool operator== (  const _Self &    rhs )  [virtual]
 

Equality operator.

Warning:
Compares only 'past the end'

Reimplemented from NodeIterator.

Definition at line 510 of file nodeiterator.h.

References NodeIterator::isEnd().

virtual void setStart (  _Node *    start )  [inline, virtual]
 

Set start node for next iteration.

Parameters:
start  The Node to start at

Reimplemented from NodeIterator.

Definition at line 184 of file nodeiterator.h.

References VariableNodeIterator::operator++().

Referenced by VariableNodeIterator::VariableNodeIterator().


The documentation for this class was generated from the following file:
Generated on Mon Jan 6 12:02:31 2003 for TreeComp by doxygen1.2.17