Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

UniWatchInfoTree Class Reference

#include <uniconfroot.h>

Inherits UniConfTree< UniWatchInfoTree >.

Collaboration diagram for UniWatchInfoTree:

[legend]
List of all members.

Detailed Description

For internal use only.

Data structure to track requested watches.

Definition at line 47 of file uniconfroot.h.

Public Types

typedef WvCallback< bool,
const UniWatchInfoTree *,
const UniWatchInfoTree *,
void * > 
Comparator

Public Member Functions

 UniWatchInfoTree (UniWatchInfoTree *parent, const UniConfKey &key=UniConfKey::EMPTY)
bool isessential ()
 Returns true if the node should not be pruned.

UniWatchInfoTreeparent () const
 Returns a pointer to the parent node, or NULL if there is none.

void setparent (UniWatchInfoTree *parent)
 Reparents this node.

UniWatchInfoTreeroot () const
 Returns a pointer to the root node of the tree.

UniConfKey fullkey (const UniWatchInfoTree *ancestor=NULL) const
 Returns full path of this node relative to an ancestor.

UniWatchInfoTreefind (const UniConfKey &key) const
 Finds the sub-node with the specified key.

UniWatchInfoTreefindchild (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 compare (const UniWatchInfoTree *other, const Comparator &comparator, void *userdata)
 Compares this tree with another using the specified comparator function.

const UniConfKeykey () const
 Returns the key field.

bool haschildren () const
 Returns true if the node has children.


Public Attributes

UniWatchInfoList watches

Protected Types

typedef WvScatterHash< UniHashTreeBase,
UniConfKey, Accessor > 
Container
typedef UniHashTreeBaseComparator BaseComparator

Protected Member Functions

void _setparent (UniHashTreeBase *parent)
UniHashTreeBase_root () const
UniConfKey _fullkey (const UniHashTreeBase *ancestor=NULL) const
UniHashTreeBase_find (const UniConfKey &key) const
UniHashTreeBase_findchild (const UniConfKey &key) const

Static Protected Member Functions

void _recursivecompare (const UniHashTreeBase *a, const UniHashTreeBase *b, const UniHashTreeBaseComparator &comparator, void *userdata)

Protected Attributes

UniConfKey xkey
UniHashTreeBasexparent
Containerxchildren


Member Typedef Documentation

typedef UniHashTreeBaseComparator UniHashTreeBase::BaseComparator [protected, inherited]
 

Definition at line 33 of file unihashtree.h.

typedef WvCallback<bool, const UniWatchInfoTree *, const UniWatchInfoTree *, void *> UniConfTree< UniWatchInfoTree , UniHashTreeBase >::Comparator [inherited]
 

Definition at line 38 of file uniconftree.h.

typedef WvScatterHash<UniHashTreeBase, UniConfKey, Accessor> UniHashTreeBase::Container [protected, inherited]
 

Definition at line 32 of file unihashtree.h.


Constructor & Destructor Documentation

UniWatchInfoTree::UniWatchInfoTree UniWatchInfoTree parent,
const UniConfKey key = UniConfKey::EMPTY
[inline]
 

Definition at line 52 of file uniconfroot.h.


Member Function Documentation

UniHashTreeBase * UniHashTreeBase::_find const UniConfKey key  )  const [protected, inherited]
 

Definition at line 90 of file unihashtree.cc.

References UniHashTreeBase::_find(), UniHashTreeBase::_findchild(), UniConfKey::Iter::next(), and UniConfKey::Iter::rewind().

Referenced by UniHashTreeBase::_find().

UniHashTreeBase * UniHashTreeBase::_findchild const UniConfKey key  )  const [protected, inherited]
 

Definition at line 104 of file unihashtree.cc.

References UniHashTreeBase::_findchild(), UniConfKey::isempty(), and UniHashTreeBase::xchildren.

Referenced by UniHashTreeBase::_find(), and UniHashTreeBase::_findchild().

UniConfKey UniHashTreeBase::_fullkey const UniHashTreeBase ancestor = NULL  )  const [protected, inherited]
 

Definition at line 63 of file unihashtree.cc.

References UniHashTreeBase::_fullkey(), UniHashTreeBase::key(), UniConfKey::prepend(), and UniHashTreeBase::xparent.

Referenced by UniHashTreeBase::_fullkey().

void UniHashTreeBase::_recursivecompare const UniHashTreeBase a,
const UniHashTreeBase b,
const UniHashTreeBaseComparator comparator,
void *  userdata
[static, protected, inherited]
 

Definition at line 140 of file unihashtree.cc.

References UniHashTreeBase::_recursivecompare(), and UniHashTreeBaseComparator.

Referenced by UniHashTreeBase::_recursivecompare().

UniHashTreeBase * UniHashTreeBase::_root  )  const [protected, inherited]
 

Definition at line 54 of file unihashtree.cc.

References UniHashTreeBase::xparent.

void UniHashTreeBase::_setparent UniHashTreeBase parent  )  [protected, inherited]
 

Definition at line 42 of file unihashtree.cc.

References UniHashTreeBase::_setparent(), UniHashTreeBase::link(), UniHashTreeBase::unlink(), and UniHashTreeBase::xparent.

Referenced by UniHashTreeBase::_setparent().

void UniConfTree< UniWatchInfoTree , UniHashTreeBase >::compare const UniWatchInfoTree other,
const Comparator comparator,
void *  userdata
[inline, inherited]
 

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 120 of file uniconftree.h.

UniWatchInfoTree * UniConfTree< UniWatchInfoTree , UniHashTreeBase >::find const UniConfKey key  )  const [inline, inherited]
 

Finds the sub-node with the specified key.

If key.isempty(), returns this node.

Definition at line 72 of file uniconftree.h.

Referenced by UniConfRoot::del_callback().

UniWatchInfoTree * UniConfTree< UniWatchInfoTree , UniHashTreeBase >::findchild const UniConfKey key  )  const [inline, inherited]
 

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 81 of file uniconftree.h.

Referenced by UniConfRoot::add_callback().

UniConfKey UniConfTree< UniWatchInfoTree , UniHashTreeBase >::fullkey const UniWatchInfoTree ancestor = NULL  )  const [inline, inherited]
 

Returns full path of this node relative to an ancestor.

If ancestor is NULL, returns the root.

Definition at line 65 of file uniconftree.h.

bool UniHashTreeBase::haschildren  )  const [inherited]
 

Returns true if the node has children.

Definition at line 113 of file unihashtree.cc.

References WvScatterHashBase::isempty(), and UniHashTreeBase::xchildren.

Referenced by UniTempGen::haschildren(), UniMountTreeGen::haschildren(), UniMountTree::isessential(), and isessential().

bool UniWatchInfoTree::isessential  )  [inline]
 

Returns true if the node should not be pruned.

Definition at line 57 of file uniconfroot.h.

References UniHashTreeBase::haschildren(), and watches.

const UniConfKey& UniHashTreeBase::key  )  const [inline, inherited]
 

Returns the key field.

Definition at line 62 of file unihashtree.h.

References UniHashTreeBase::xkey.

Referenced by UniHashTreeBase::_fullkey(), and UniHashTreeBase::Accessor::get_key().

UniWatchInfoTree * UniConfTree< UniWatchInfoTree , UniHashTreeBase >::parent  )  const [inline, inherited]
 

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

Definition at line 50 of file uniconftree.h.

void UniConfTree< UniWatchInfoTree , UniHashTreeBase >::remove const UniConfKey key  )  [inline, inherited]
 

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 90 of file uniconftree.h.

UniWatchInfoTree * UniConfTree< UniWatchInfoTree , UniHashTreeBase >::root  )  const [inline, inherited]
 

Returns a pointer to the root node of the tree.

Definition at line 58 of file uniconftree.h.

void UniConfTree< UniWatchInfoTree , UniHashTreeBase >::setparent UniWatchInfoTree parent  )  [inline, inherited]
 

Reparents this node.

Definition at line 54 of file uniconftree.h.

void UniConfTree< UniWatchInfoTree , UniHashTreeBase >::zap  )  [inline, inherited]
 

Removes and deletes all children of this node.

Definition at line 94 of file uniconftree.h.


Member Data Documentation

UniWatchInfoList UniWatchInfoTree::watches
 

Definition at line 50 of file uniconfroot.h.

Referenced by UniConfRoot::add_callback(), UniConfRoot::del_callback(), and isessential().

Container* UniHashTreeBase::xchildren [protected, inherited]
 

the hash table of children

Definition at line 34 of file unihashtree.h.

Referenced by UniHashTreeBase::_findchild(), UniHashTreeBase::haschildren(), UniHashTreeBase::Iter::Iter(), UniHashTreeBase::UniHashTreeBase(), and UniHashTreeBase::~UniHashTreeBase().

UniConfKey UniHashTreeBase::xkey [protected, inherited]
 

the name of this entry

Definition at line 23 of file unihashtree.h.

Referenced by UniHashTreeBase::key().

UniHashTreeBase* UniHashTreeBase::xparent [protected, inherited]
 

the parent of this subtree

Definition at line 24 of file unihashtree.h.

Referenced by UniHashTreeBase::_fullkey(), UniHashTreeBase::_root(), UniHashTreeBase::_setparent(), UniHashTreeBase::UniHashTreeBase(), and UniHashTreeBase::~UniHashTreeBase().


The documentation for this class was generated from the following file:
Generated on Tue Oct 5 01:09:34 2004 for WvStreams by doxygen 1.3.7