KDE 4.2 API Reference kalzium
Avogadro::Node Class Reference
#include <skeletontree.h>
Inheritance diagram for Avogadro::Node:
Detailed Description
A node of a tree used to represent a molecule in a skeletal-like structure.This class represents a node in a particular tree structure. It holds an Atom and pointers to any number of child nodes.
Definition at line 47 of file skeletontree.h.
Public Member Functions | |
| void | addNode (Node *node) |
| Atom * | atom () |
| bool | containsAtom (Atom *atom) |
| bool | isLeaf () |
| Node (Atom *atom) | |
| QList< Node * > * | nodes () |
| void | removeNode (Node *node) |
| virtual | ~Node () |
Protected Attributes | |
| Atom * | m_atom |
| QList< Node * > | m_nodes |
Constructor & Destructor Documentation
| Avogadro::Node::Node | ( | Atom * | atom | ) |
| Avogadro::Node::~Node | ( | ) | [virtual] |
Member Function Documentation
| void Avogadro::Node::addNode | ( | Node * | node | ) |
| Atom * Avogadro::Node::atom | ( | ) |
| bool Avogadro::Node::containsAtom | ( | Atom * | atom | ) |
Determines whether or not this Node, or any of the Nodes in the (sub)tree that this Node is the root of, contains the given Atom.
- Parameters:
-
atom The Atom being searched for in this Node's (sub)tree.
- Returns:
- True if the Atom was found in the (sub)tree, false otherwise.
Definition at line 71 of file skeletontree.cpp.
| bool Avogadro::Node::isLeaf | ( | ) |
Determines whether or not this Node is a leaf in the SkeletonTree.
- Returns:
- True if this Node is a leaf in the tree, false otherwise.
Definition at line 64 of file skeletontree.cpp.
| void Avogadro::Node::removeNode | ( | Node * | node | ) |
Removes the given Node from this Node's children.
- Parameters:
-
node The Node being removed from this Node's children.
Definition at line 101 of file skeletontree.cpp.
Member Data Documentation
Atom* Avogadro::Node::m_atom [protected] |
Definition at line 52 of file skeletontree.h.
QList<Node*> Avogadro::Node::m_nodes [protected] |
Definition at line 53 of file skeletontree.h.
The documentation for this class was generated from the following files:
