The named tree class is used to form a tree oriented list of associated objects. More...
#include <linked.h>
Public Member Functions | |
NamedTree * | find (const char *name) const |
Find a child node of our object with the specified name. | |
NamedTree * | getChild (const char *name) const |
Find a direct child of our node which matches the specified name. | |
NamedTree * | getFirst (void) const |
Get first child node in our ordered list of children. | |
OrderedIndex * | getIndex (void) const |
Get the ordered index of our child nodes. | |
NamedTree * | getIndexed (unsigned index) const |
Get child by index number. | |
NamedTree * | getLeaf (const char *name) const |
Find a direct leaf node on our node. | |
NamedTree * | getParent (void) const |
Get parent node we are listed as a child on. | |
bool | is_leaf (void) const |
Test if node has children. | |
bool | is_root (void) const |
Test if node is root node. | |
NamedTree * | leaf (const char *name) const |
Find a child leaf node of our object with the specified name. | |
operator bool () const | |
Test if this node has a name. | |
bool | operator! () const |
Test if this node is unnamed. | |
NamedTree * | path (const char *path) const |
Find a subnode by a dot separated list of node names. | |
void | relist (NamedTree *trunk=NULL) |
Default relist is by tail. | |
void | relistHead (NamedTree *trunk) |
Add leaf to a trunk, by reverse order. | |
void | relistTail (NamedTree *trunk) |
Add leaf to a trunk, by order. | |
void | remove (void) |
Remove our node from our parent list. | |
void | setId (char *name) |
Set or replace the name id of this node. | |
Protected Member Functions | |
NamedTree (const NamedTree &source) | |
Construct a copy of the tree. | |
NamedTree (NamedTree *parent, char *name) | |
Create a tree node as a child of an existing node. | |
NamedTree (char *name=NULL) | |
Create a stand-alone or root tree node, with an optional name. | |
void | purge (void) |
Performs object destruction. | |
virtual | ~NamedTree () |
Delete node in a tree. | |
Protected Attributes | |
OrderedIndex | Child |
NamedTree * | Parent |
The named tree class is used to form a tree oriented list of associated objects.
Typical uses for such data structures might be to form a parsed XML document, or for forming complex configuration management systems or for forming system resource management trees.
Definition at line 585 of file linked.h.
ucommon::NamedTree::NamedTree | ( | char * | name = NULL |
) | [protected] |
Create a stand-alone or root tree node, with an optional name.
name | for this node. |
ucommon::NamedTree::NamedTree | ( | NamedTree * | parent, | |
char * | name | |||
) | [protected] |
Create a tree node as a child of an existing node.
parent | node we are listed under. | |
name | of our node. |
ucommon::NamedTree::NamedTree | ( | const NamedTree & | source | ) | [protected] |
Construct a copy of the tree.
source | object to copy from. |
virtual ucommon::NamedTree::~NamedTree | ( | ) | [protected, virtual] |
Delete node in a tree.
If we delete a node, we must delist it from it's parent. We must also delink any child nodes. This is done by calling the purge() member.
NamedTree* ucommon::NamedTree::find | ( | const char * | name | ) | const |
Find a child node of our object with the specified name.
This will also recursivily search all child nodes that have children until the named node can be found. This seeks a child node that has children.
name | to search for. |
Reimplemented in ucommon::treemap< T >.
NamedTree* ucommon::NamedTree::getChild | ( | const char * | name | ) | const |
Find a direct child of our node which matches the specified name.
name | of child node to find. |
Reimplemented in ucommon::treemap< T >.
NamedTree* ucommon::NamedTree::getFirst | ( | void | ) | const [inline] |
Get first child node in our ordered list of children.
This might be used to iterate child nodes. This may also be used to get unamed child nodes.
Reimplemented in ucommon::treemap< T >.
OrderedIndex* ucommon::NamedTree::getIndex | ( | void | ) | const [inline] |
NamedTree* ucommon::NamedTree::getIndexed | ( | unsigned | index | ) | const [inline] |
Get child by index number.
index | of child to fetch. |
Reimplemented in ucommon::treemap< T >.
NamedTree* ucommon::NamedTree::getLeaf | ( | const char * | name | ) | const |
Find a direct leaf node on our node.
A leaf node is a node that has no children of it's own. This does not perform a recursive search.
name | of leaf child node to find. |
Reimplemented in ucommon::treemap< T >.
NamedTree* ucommon::NamedTree::getParent | ( | void | ) | const [inline] |
Get parent node we are listed as a child on.
Reimplemented in ucommon::treemap< T >.
bool ucommon::NamedTree::is_leaf | ( | void | ) | const [inline] |
bool ucommon::NamedTree::is_root | ( | void | ) | const [inline] |
NamedTree* ucommon::NamedTree::leaf | ( | const char * | name | ) | const |
Find a child leaf node of our object with the specified name.
This will recursively search all our child nodes until it can find a leaf node containing the specified id but that holds no further children.
name | of leaf node to search for. |
Reimplemented in ucommon::treemap< T >.
ucommon::NamedTree::operator bool | ( | ) | const [inline] |
bool ucommon::NamedTree::operator! | ( | ) | const [inline] |
NamedTree* ucommon::NamedTree::path | ( | const char * | path | ) | const |
Find a subnode by a dot separated list of node names.
If one or more lead dots are used, then the search will go through parent node levels of our node. The dot separated list could be thought of as a kind of pathname where dot is used like slash. This implies that individual nodes can never use names which contain dot's if the path function will be used.
path | name string being sought. |
Reimplemented in ucommon::treemap< T >.
void ucommon::NamedTree::purge | ( | void | ) | [protected] |
Performs object destruction.
Note, if we delete a named tree object the name of our member object is assumed to be a dynamically allocated string that will also be free'd.
void ucommon::NamedTree::relist | ( | NamedTree * | trunk = NULL |
) | [inline] |
void ucommon::NamedTree::relistHead | ( | NamedTree * | trunk | ) |
Add leaf to a trunk, by reverse order.
If NULL, just remove.
trunk | we add leaf node to. |
void ucommon::NamedTree::relistTail | ( | NamedTree * | trunk | ) |
Add leaf to a trunk, by order.
If NULL, just remove.
trunk | we add leaf node to. |
void ucommon::NamedTree::remove | ( | void | ) |
Remove our node from our parent list.
The name is set to NULL to keep delete from freeing the name string.
void ucommon::NamedTree::setId | ( | char * | name | ) |
Set or replace the name id of this node.
This will free the string if a name had already been set.
name | for this node to set. |