name: TreeNode<TObject>

synopsis:


g++ [flags ...] file ... -l /isip/tools/lib/$ISIP_BINARY/lib_dstr_a

#include <TreeNode.h>

long degree() const;
boolean increment();
boolean decrement();
TreeNode<TObject>* getParent() const;
boolean setParent(const TreeNode<TObject>* arg);
TreeNode<TObject>* getLeftChild() const;
boolean setLeftChild(const TreeNode<TObject>* arg);
TreeNode<TObject>* getRightSibling() const;
boolean setRightSibling(const TreeNode<TObject>* arg);
boolean isAdjacent(const TObject* obj) const;
boolean isAdjacent(const TreeNode<TObject>* node) const;

quick start:


TreeNode<Ulong> tree_node;

tree_node.setParent((TreeNode<Ulong>*)NULL);
tree_node.increment();
tree_node.decrement();

description:

This class is used to implements a tree node and forms the basis of the Tree class data structure.

dependencies:

public constants:

define public constants:

static const String CLASS_NAME;

static const String DEF_PARAM;

define default values and arguments:
```
static const long DEF_DEGREE = 0;
```

error codes:

none.

protected data:

define a pointer to the parent node:

TreeNode<TObject>* parent_d;

define a pointer to the left child node:

TreeNode<TObject>* left_d;

define a pointer to the right child node:

TreeNode<TObject>* right_d;

define the out degree of the node:

Long degree_d;

declare the debugging parameters:
```
static Integral::DEBUG debug_level_d;
```
declare the memory manager:
```
static MemoryManager mgr_d;
```

required public methods:

static methods:
```
static const String& name();
```

debug methods:

static boolean setDebug(Integral::DEBUG debug_level);

boolean debug(const unichar* msg) const;

destructor/constructor(s):

~TreeNode();

TreeNode(TObject* item = (TObject*)NULL);

TreeNode(const TreeNode<TObject>& copy_tnode);

not present.

assign methods:

boolean assign(const TreeNode<TObject>& copy_stack);

operator= method:

TreeNode<TObject>& operator=(const TreeNode<TObject>& arg);

i/o methods:

long sofSize() const;

boolean read(Sof& sof, long tag);

boolean write(Sof& sof, long tag) const;

boolean read(Sof& sof, long tag, const String& name);

boolean write(Sof& sof, long tag, const String& name) const;

boolean readData(Sof& sof, const String& pname = DEF_PARAM, long size = SofParser::FULL_OBJECT, boolean param = true, boolean nested = true);

boolean writeData(Sof& sof, const String& pname = DEF_PARAM) const;

equality methods:

boolean eq(const TreeNode<TObject>& arg) const;

memory management methods:

static void* operator new(size_t size);

static void* operator new[](size_t size);

static void operator delete(void* ptr);

static void operator delete[](void* ptr);

static boolean setGrowSize(long grow_size);

boolean clear(Integral::CMODE cmode = Integral::DEF_CMODE);

class-specific public methods:

node degree methods:

long degree() const;

boolean increment();

boolean decrement();

node parent methods:

TreeNode<TObject>* getParent() const;

boolean setParent(const TreeNode<TObject>* arg);

node children methods:

TreeNode<TObject>* getLeftChild() const;

boolean setLeftChild(const TreeNode<TObject>* arg);

node sibling methods:

TreeNode<TObject>* getRightSibling() const;

boolean setRightSibling(const TreeNode<TObject>* arg);

node adjacency methods:

boolean isAdjacent(const TObject* obj) const;

boolean isAdjacent(const TreeNode<TObject>* node) const;

private methods:

declare private methods:

template <class TObject_diagnose> friend class TreeNodeDiagnose;

examples:

none.

notes:

none.