Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

XFuNTreeAbstractIterator< T > Class Template Reference

#include <XFuNTreeAbstractIterator.h>

Inheritance diagram for XFuNTreeAbstractIterator< T >:

Inheritance graph
[legend]
List of all members.

Public Member Functions

INT operator!= (const XFuNTreeAbstractIterator &aRef) const
 Checks if the nodes pointed by two iterators are inequal.

INT operator== (const XFuNTreeAbstractIterator &aRef) const
 Checks if the nodes pointed by two iterators are equal.

UINT32 size () const
 Returns the amount of allocated child nodes.

INT isValid () const
 Returns information about the validity of the node.

INT isValid (const UINT32 aIndex) const
 Returns information about the validity of the Nth child node.

INT isLeaf () const
 Checks whether the node is a leaf node.

INT setData (T aNewData)
 Sets the internal data of a node.

getData () const
 Returns the internal data of a node.


Protected Member Functions

 XFuNTreeAbstractIterator ()
 Creates an empty iterator.

 XFuNTreeAbstractIterator (XFuNTreeNode< T > *aNode, const UINT32 aChildNodes)
 Creates an iterator pointing to a node.


Protected Attributes

UINT32 mChildNodes
 Number of child nodes in each node.

XFuNTreeNode< T > * mNode
 Current node.


Friends

class XFuNTree< T >

template<class T>
class XFuNTreeAbstractIterator< T >


Constructor & Destructor Documentation

template<class T>
XFuNTreeAbstractIterator< T >::XFuNTreeAbstractIterator   [protected]
 

Creates an empty iterator.

Definition at line 158 of file XFuNTreeAbstractIterator.h.

References XFuNTreeAbstractIterator< T >::mChildNodes, and XFuNTreeAbstractIterator< T >::mNode.

template<class T>
XFuNTreeAbstractIterator< T >::XFuNTreeAbstractIterator XFuNTreeNode< T > *    aNode,
const UINT32    aChildNodes
[protected]
 

Creates an iterator pointing to a node.

Definition at line 165 of file XFuNTreeAbstractIterator.h.

References XFuNTreeAbstractIterator< T >::mChildNodes, and XFuNTreeAbstractIterator< T >::mNode.


Member Function Documentation

template<class T>
T XFuNTreeAbstractIterator< T >::getData   const
 

Returns the internal data of a node.

Returns:
Internal data of a node

Definition at line 152 of file XFuNTreeAbstractIterator.h.

References XFuNTreeAbstractIterator< T >::mNode.

template<class T>
INT XFuNTreeAbstractIterator< T >::isLeaf   const
 

Checks whether the node is a leaf node.

Returns:
1 if the node is a leaf node, 0 otherwise

Definition at line 131 of file XFuNTreeAbstractIterator.h.

References XFuNTreeAbstractIterator< T >::mNode.

template<class T>
INT XFuNTreeAbstractIterator< T >::isValid const UINT32    aIndex const
 

Returns information about the validity of the Nth child node.

Parameters:
aIndex Index of child node.
Returns:
1 if the node is valid, 0 otherwise.

Definition at line 122 of file XFuNTreeAbstractIterator.h.

References XFuNTreeAbstractIterator< T >::mNode.

template<class T>
INT XFuNTreeAbstractIterator< T >::isValid   const
 

Returns information about the validity of the node.

Returns:
1 if the node is valid, 0 otherwise.

Definition at line 112 of file XFuNTreeAbstractIterator.h.

References XFuNTreeAbstractIterator< T >::mNode.

Referenced by XFuNTree< T >::add(), and XFuNTree< T >::insert().

template<class T>
INT XFuNTreeAbstractIterator< T >::operator!= const XFuNTreeAbstractIterator< T > &    aRef const
 

Checks if the nodes pointed by two iterators are inequal.

Returns:
1 if inequal, 0 otherwise.

Definition at line 84 of file XFuNTreeAbstractIterator.h.

References XFuNTreeAbstractIterator< T >::mNode.

template<class T>
INT XFuNTreeAbstractIterator< T >::operator== const XFuNTreeAbstractIterator< T > &    aRef const
 

Checks if the nodes pointed by two iterators are equal.

Returns:
1 if equal, 0 otherwise.

Definition at line 94 of file XFuNTreeAbstractIterator.h.

References XFuNTreeAbstractIterator< T >::mNode.

template<class T>
INT XFuNTreeAbstractIterator< T >::setData   aNewData
 

Sets the internal data of a node.

Returns:
1 if the addition succeeded, 0 if an error occured

Definition at line 140 of file XFuNTreeAbstractIterator.h.

References XFuNTreeAbstractIterator< T >::mNode.

template<class T>
UINT32 XFuNTreeAbstractIterator< T >::size   const
 

Returns the amount of allocated child nodes.

Returns:
Amount of allocated child nodes, 0 if node is not valid

Definition at line 103 of file XFuNTreeAbstractIterator.h.

References XFuNTreeAbstractIterator< T >::mNode.


Friends And Related Function Documentation

template<class T>
friend class XFuNTree< T > [friend]
 

Definition at line 79 of file XFuNTreeAbstractIterator.h.


Member Data Documentation

template<class T>
UINT32 XFuNTreeAbstractIterator< T >::mChildNodes [protected]
 

Number of child nodes in each node.

Definition at line 69 of file XFuNTreeAbstractIterator.h.

Referenced by XFuNTreeRandomAccessIterator< T >::getChild(), XFuNTreePreOrderIterator< T >::operator++(), XFuNTreePostOrderIterator< T >::operator++(), XFuNTreePreOrderIterator< T >::operator=(), XFuNTreePostOrderIterator< T >::operator=(), XFuNTreeAbstractIterator< T >::XFuNTreeAbstractIterator(), XFuNTreePostOrderIterator< T >::XFuNTreePostOrderIterator(), XFuNTreePreOrderIterator< T >::XFuNTreePreOrderIterator(), and XFuNTreeRandomAccessIterator< T >::XFuNTreeRandomAccessIterator().

template<class T>
XFuNTreeNode<T>* XFuNTreeAbstractIterator< T >::mNode [protected]
 

Current node.

Definition at line 72 of file XFuNTreeAbstractIterator.h.

Referenced by XFuNTree< T >::add(), XFuNTreeRandomAccessIterator< T >::advance(), XFuNTreeRandomAccessIterator< T >::backup(), XFuNTreeRandomAccessIterator< T >::getChild(), XFuNTreeAbstractIterator< T >::getData(), XFuNTree< T >::insert(), XFuNTreeAbstractIterator< T >::isLeaf(), XFuNTreeAbstractIterator< T >::isValid(), XFuNTreeAbstractIterator< T >::operator!=(), XFuNTreePreOrderIterator< T >::operator++(), XFuNTreePostOrderIterator< T >::operator++(), XFuNTreePreOrderIterator< T >::operator=(), XFuNTreePostOrderIterator< T >::operator=(), XFuNTreeAbstractIterator< T >::operator==(), XFuNTree< T >::remove(), XFuNTreeAbstractIterator< T >::setData(), XFuNTreeAbstractIterator< T >::size(), XFuNTreeAbstractIterator< T >::XFuNTreeAbstractIterator(), XFuNTreePostOrderIterator< T >::XFuNTreePostOrderIterator(), XFuNTreePreOrderIterator< T >::XFuNTreePreOrderIterator(), and XFuNTreeRandomAccessIterator< T >::XFuNTreeRandomAccessIterator().


The documentation for this class was generated from the following file:
   
X-Forge Documentation
Confidential
Copyright © 2002-2003 Fathammer
   
Documentation generated
with doxygen
by Dimitri van Heesch