dataUtils::Node Class Reference
Public Member Functions | |
| def | __init__ |
| def | __cmp__ |
| def | __repr__ |
| def | toString |
| def | addChild |
| def | removeChild |
| def | removeAllChildren |
| def | getChildren |
| def | setContent |
| def | getContent |
| def | dropContent |
| def | searchChildren |
| def | listDepthFirst |
| def | listByHeight |
| def | searchContent |
| def | searchPathToContent |
| def | display |
Public Attributes | |
| content | |
| children | |
Detailed Description
Nodes are trees : they can contain other nodes. Each node can carry a content, whose type is NodeContent.
Definition at line 28 of file dataUtils.py.
Member Function Documentation
| def dataUtils::Node::__cmp__ | ( | self, | ||
| other | ||||
| ) |
Definition at line 41 of file dataUtils.py.
| def dataUtils::Node::__init__ | ( | self, | ||
newContent = None | ||||
| ) |
Creates an empty node with no child node.
Reimplemented in dataUtils::NodeExample.
Definition at line 35 of file dataUtils.py.
| def dataUtils::Node::__repr__ | ( | self | ) |
Returns a textual representation of this node's state.
Definition at line 45 of file dataUtils.py.
| def dataUtils::Node::addChild | ( | self, | ||
| aChild | ||||
| ) |
Adds a child to current node.
Definition at line 109 of file dataUtils.py.
| def dataUtils::Node::display | ( | self | ) |
Definition at line 215 of file dataUtils.py.
| def dataUtils::Node::dropContent | ( | self | ) |
Removes this node's content.
Definition at line 140 of file dataUtils.py.
| def dataUtils::Node::getChildren | ( | self | ) |
Returns this node's children.
Definition at line 123 of file dataUtils.py.
| def dataUtils::Node::getContent | ( | self | ) |
Returns this node's current content.
Definition at line 135 of file dataUtils.py.
| def dataUtils::Node::listByHeight | ( | self, | ||
first = True | ||||
| ) |
Walks the tree height by height, starting from root node, and returns the list of encountered nodes.
Definition at line 164 of file dataUtils.py.
| def dataUtils::Node::listDepthFirst | ( | self | ) |
Walks the tree depth-first, returns the list of encountered nodes.
Definition at line 153 of file dataUtils.py.
| def dataUtils::Node::removeAllChildren | ( | self | ) |
Definition at line 119 of file dataUtils.py.
| def dataUtils::Node::removeChild | ( | self, | ||
| child | ||||
| ) |
Removes specified child, raises an exception if child not found.
Definition at line 114 of file dataUtils.py.
| def dataUtils::Node::searchChildren | ( | self, | ||
| content | ||||
| ) |
Searches through node's children the first, if any, that has specified content.
Definition at line 145 of file dataUtils.py.
| def dataUtils::Node::searchContent | ( | self, | ||
| content | ||||
| ) |
Searches through internal content and then recursively through children for specified content.Returns the first node found having the content, if any. Otherwise, returns None. content -> list of nodes
Definition at line 178 of file dataUtils.py.
| def dataUtils::Node::searchPathToContent | ( | self, | ||
| content | ||||
| ) |
Returns, if possible, the path from the first found node whose content matches specified content to root node.
Definition at line 196 of file dataUtils.py.
| def dataUtils::Node::setContent | ( | self, | ||
| nodeContent | ||||
| ) |
Sets a new content to current node, which must not have already a content.
Definition at line 128 of file dataUtils.py.
| def dataUtils::Node::toString | ( | self, | ||
offset = 0, |
||||
nextOffset = 0, |
||||
isFirstChild = True | ||||
| ) |
Returns a stringified description of the tree.
__ a __ b
|_ c __ d __ e
|_ f
|_ g
offset is the current position where to write
nexOffset is the position where children should begin
Definition at line 61 of file dataUtils.py.
Member Data Documentation
Definition at line 38 of file dataUtils.py.
Reimplemented in dataUtils::NodeExample.
Definition at line 37 of file dataUtils.py.
The documentation for this class was generated from the following file:
