OpenBabel::OBRTree

OBRTree Class Reference

Internal class for OBRing search algorithms to create a search tree of OBAtom objects. More...

#include <openbabel/ring.h>

List of all members.

Public Member Functions

 OBRTree (OBAtom *, OBRTree *)
 ~OBRTree ()
int GetAtomIdx ()
void PathToRoot (std::vector< OBAtom * > &)

Detailed Description

Internal class for OBRing search algorithms to create a search tree of OBAtom objects.

Constructor & Destructor Documentation

OBRTree ( OBAtom *  ,
OBRTree *   
)

Construct a search tree from a possible parent entry and atom entry.

~OBRTree (  )  [inline]

Member Function Documentation

int GetAtomIdx (  ) 

Returns:
the OBAtom::GetIdx() index of the atom in this node

void PathToRoot ( std::vector< OBAtom * > &  path  ) 

Recursively find the root of this tree, building up a vector of OBAtom nodes.

The supplied path is built up of OBAtom nodes, with the root atom the last item in the vector.

The documentation for this class was generated from the following files: