phoenix::Chain Class Reference
[Graph/Tree Types and Classes]

Chain Class This class is the top level in the molecular tree structure. It has a name, a ResidueList with all residues and a tag. More...

#include <chain.hpp>

List of all members.

Public Member Functions

string Name () const
 returns the name of the chain
void Name (string n)
 sets the name of the chain
ResidueList Residues () const
 return the residues of the chain
string Tag () const
 returns the tag of the chain
void Tag (string t)
 sets the tag of the chain
bool Valid () const
 returns a validation flag, only with -DDEBUG

Friends

ChainKey cCreate (string n)
 Create a new chain.
void cDelete (ChainKey k)
 Delete a chain.
ResidueKey rCreate (ChainKey p, RT rt)
 Create a new residue.
void rDelete (ResidueKey k)
 Delete a residue.


Detailed Description

Chain Class This class is the top level in the molecular tree structure. It has a name, a ResidueList with all residues and a tag.

Friends And Related Function Documentation

ChainKey cCreate ( string  n  )  [friend]

Create a new chain.

Create a new chain with name n and return the new ChainKey.

void cDelete ( ChainKey  k  )  [friend]

Delete a chain.

Delete chain c and all of its children.

ResidueKey rCreate ( ChainKey  p,
RT  rt 
) [friend]

Create a new residue.

Create a new residue of type rt at the end of chain p and return the new ResidueKey.

void rDelete ( ResidueKey  k  )  [friend]

Delete a residue.

Delete residue r and all of its children.


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

Generated on Mon Nov 23 08:31:45 2009 for ParaDockS by  doxygen 1.5.8