UniConfTree< Sub, Base > Class Template Reference

#include <uniconftree.h>

Inheritance diagram for UniConfTree< Sub, Base >:
[legend]

List of all members.


Detailed Description

template<class Sub, class Base = UniHashTreeBase>
class UniConfTree< Sub, Base >

A recursively composed dictionary for tree-structured data indexed by UniConfKey.

Someday this could be further abstracted into a generic WvTreeDict.

"Sub" is the name of the concrete subclass of UniConfTree.

Definition at line 23 of file uniconftree.h.


Public Types

typedef WvCallback< void,
const Sub *, void * > 
Visitor
typedef WvCallback< bool,
const Sub *, const Sub *,
void * > 
Comparator

Public Member Functions

 UniConfTree (Sub *parent, const UniConfKey &key)
 Creates a node and links it to a subtree, if parent is non-NULL.
 ~UniConfTree ()
 Destroy this node's contents and children.
Sub * parent () const
 Returns a pointer to the parent node, or NULL if there is none.
void setparent (Sub *parent)
 Reparents this node.
Sub * root () const
 Returns a pointer to the root node of the tree.
UniConfKey fullkey (const Sub *ancestor=NULL) const
 Returns full path of this node relative to an ancestor.
Sub * find (const UniConfKey &key) const
 Finds the sub-node with the specified key.
Sub * findchild (const UniConfKey &key) const
 Finds the direct child node with the specified key.
void remove (const UniConfKey &key)
 Removes the node for the specified key from the tree and deletes it along with any of its children.
void zap ()
 Removes and deletes all children of this node.
void visit (const Visitor &visitor, void *userdata, bool preorder=true, bool postorder=false) const
 Performs a traversal on this tree using the specified visitor function and traversal type(s).
bool compare (const Sub *other, const Comparator &comparator, void *userdata)
 Compares this tree with another using the specified comparator function.

Classes

class  Iter
 An iterator that walks over all elements on one level of a UniConfTree. More...

Constructor & Destructor Documentation

template<class Sub, class Base = UniHashTreeBase>
UniConfTree< Sub, Base >::~UniConfTree (  )  [inline]

Destroy this node's contents and children.

Definition at line 36 of file uniconftree.h.


Member Function Documentation

template<class Sub, class Base = UniHashTreeBase>
Sub* UniConfTree< Sub, Base >::parent (  )  const [inline]

Returns a pointer to the parent node, or NULL if there is none.

Definition at line 40 of file uniconftree.h.

template<class Sub, class Base = UniHashTreeBase>
void UniConfTree< Sub, Base >::setparent ( Sub *  parent  )  [inline]

Reparents this node.

Definition at line 44 of file uniconftree.h.

template<class Sub, class Base = UniHashTreeBase>
Sub* UniConfTree< Sub, Base >::root (  )  const [inline]

Returns a pointer to the root node of the tree.

Definition at line 48 of file uniconftree.h.

template<class Sub, class Base = UniHashTreeBase>
UniConfKey UniConfTree< Sub, Base >::fullkey ( const Sub *  ancestor = NULL  )  const [inline]

Returns full path of this node relative to an ancestor.

If ancestor is NULL, returns the root.

Definition at line 55 of file uniconftree.h.

Referenced by UniTransactionGen::deletion_visitor(), and UniTempGen::set().

template<class Sub, class Base = UniHashTreeBase>
Sub* UniConfTree< Sub, Base >::find ( const UniConfKey key  )  const [inline]

Finds the sub-node with the specified key.

If key.isempty(), returns this node.

Definition at line 62 of file uniconftree.h.

Referenced by UniFastRegetGen::gencallback(), UniTempGen::get(), UniFastRegetGen::get(), UniTempGen::haschildren(), UniFastRegetGen::haschildren(), UniTempGen::iterator(), UniConfTree< UniConfChangeTree >::remove(), and UniTempGen::set().

template<class Sub, class Base = UniHashTreeBase>
Sub* UniConfTree< Sub, Base >::findchild ( const UniConfKey key  )  const [inline]

Finds the direct child node with the specified key.

If key.numsegments() == 1, then performs the same task as find(key), but a little faster. Otherwise returns NULL.

Definition at line 71 of file uniconftree.h.

Referenced by UniTransactionGen::apply_values(), UniTransactionGen::cancel_values(), and UniTempGen::set().

template<class Sub, class Base = UniHashTreeBase>
void UniConfTree< Sub, Base >::remove ( const UniConfKey key  )  [inline]

Removes the node for the specified key from the tree and deletes it along with any of its children.

If the key is UniConfKey::EMPTY, deletes this object.

Definition at line 80 of file uniconftree.h.

template<class Sub, class Base = UniHashTreeBase>
void UniConfTree< Sub, Base >::zap (  )  [inline]

Removes and deletes all children of this node.

Definition at line 84 of file uniconftree.h.

Referenced by UniConfTree< UniConfChangeTree >::~UniConfTree().

template<class Sub, class Base = UniHashTreeBase>
void UniConfTree< Sub, Base >::visit ( const Visitor &  visitor,
void *  userdata,
bool  preorder = true,
bool  postorder = false 
) const [inline]

Performs a traversal on this tree using the specified visitor function and traversal type(s).

"visitor" is the tree visitor function "userdata" is userdata for the tree visitor function

Definition at line 108 of file uniconftree.h.

Referenced by UniTempGen::set().

template<class Sub, class Base = UniHashTreeBase>
bool UniConfTree< Sub, Base >::compare ( const Sub *  other,
const Comparator &  comparator,
void *  userdata 
) [inline]

Compares this tree with another using the specified comparator function.

Comparison of a subtree ends when the comparator returns false. "comparator" is the value compare function "userdata" is userdata for the compare function Returns: true if the comparison function returned true each time

Definition at line 124 of file uniconftree.h.

Referenced by UniIniGen::refresh().


The documentation for this class was generated from the following file:
Generated on Thu Jan 24 16:50:58 2008 for WvStreams by  doxygen 1.5.4