The Gnome Chemistry Utils  0.13.7
Public Member Functions
gcp::FragmentResidue Class Reference

#include <gcp/fragment-residue.h>

Inheritance diagram for gcp::FragmentResidue:
gcp::FragmentAtom gcp::Atom gcu::Atom gcu::DialogOwner gccv::ItemClient gcu::Object

List of all members.

Public Member Functions

 FragmentResidue ()
 FragmentResidue (Fragment *fragment, char const *symbol)
virtual ~FragmentResidue ()
xmlNodePtr Save (xmlDocPtr xml) const
bool Load (xmlNodePtr node)
void SetResidue (Residue const *res, char const *symbol=NULL)
const gchar * GetSymbol () const
Residue const * GetResidue (void) const
std::string GetAbbrev (void) const

Detailed Description

Represents a residue inside a atoms group (see gcp::Fragment class).

Definition at line 38 of file fragment-residue.h.


Constructor & Destructor Documentation

The default constructor.

gcp::FragmentResidue::FragmentResidue ( Fragment fragment,
char const *  symbol 
)
Parameters:
fragmentthe fragment containing the residue symbol.
symbolthe residue symbol.

Constructs a FragmentResidue as a child of fragment.

The destructor.


Member Function Documentation

gcp::FragmentResidue::GetAbbrev ( void  ) const [inline]
Returns:
the used symbol for the residue.

Definition at line 90 of file fragment-residue.h.

gcp::FragmentResidue::GetResidue ( void  ) const [inline]
Returns:
the associated residue.

Definition at line 86 of file fragment-residue.h.

const gchar* gcp::FragmentResidue::GetSymbol ( ) const [virtual]
Returns:
the symbol of this Residue.

Reimplemented from gcu::Atom.

bool gcp::FragmentResidue::Load ( xmlNodePtr  node) [virtual]
Parameters:
nodean XML node.

Loads the symbol and associated resdue from node.

Returns:
true on success, false otherwise.

Reimplemented from gcp::FragmentAtom.

xmlNodePtr gcp::FragmentResidue::Save ( xmlDocPtr  xml) const [virtual]
Parameters:
xmlthe xmlDoc used to save the document.

Builds an XML node representing this instance.

Returns:
the new XML node or NULL on error.

Reimplemented from gcp::FragmentAtom.

void gcp::FragmentResidue::SetResidue ( Residue const *  res,
char const *  symbol = NULL 
)
Parameters:
resthe residue corresponding to the symbol.
symbolthe symbol to use, or NULL to use the default symbol.

Sets the associated residue.


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