Fragment Class Reference
[Molecular Datastructures]

Fragment class. More...

#include <fragment.h>

Inheritance diagram for Fragment:

List of all members.

Public Types
Enums
enum	Property { NUMBER_OF_PROPERTIES = AtomContainer::NUMBER_OF_PROPERTIES }
	The number of predefined properties for AtomContainer.
Public Member Functions
bool	operator== (const Fragment &fragment) const throw ()
	Equality operator.
bool	operator!= (const Fragment &fragment) const throw ()
	Inequality operator.
Constructors and Destructors
	Fragment () throw ()
	Default constructor.
	Fragment (const Fragment &fragment, bool deep=true) throw ()
	Copy constructor.
	Fragment (const String &name) throw ()
	Constructor.
virtual	~Fragment () throw ()
	Destructor.
Persistence
void	persistentWrite (PersistenceManager &pm, const char *name=0) const throw (Exception::GeneralException)
	Writes a Fragment object to a persistent stream.
void	persistentRead (PersistenceManager &pm) throw (Exception::GeneralException)
	Reads a Fragment object from a persistent stream.
Assignment
Fragment &	operator= (const Fragment &fragment) throw ()
	Assignment operator.
Debugging and Diagnostics
virtual void	dump (std::ostream &s=std::cout, Size depth=0) const throw ()
	Internal state dump.

---

Detailed Description

Fragment class.

Fragments are used to represent parts of molecules (for example functional groups, monomers in larger polymers).

---

Member Function Documentation

virtual void Fragment::dump (  std::ostream &  s = std::cout, Size  depth = 0 )  const throw () [virtual]

Internal state dump. Dump the current internal state to the output ostream s with dumping depth depth . Parameters: s  - output stream where to output the internal state depth  - the dumping depth Reimplemented from AtomContainer. Reimplemented in Nucleotide, and Residue.

bool Fragment::operator!= (  const Fragment &  fragment  )  const throw ()

Inequality operator. See also: operator ==

Fragment& Fragment::operator= (  const Fragment &  fragment  )  throw ()

Assignment operator. Parameters: fragment  the Fragment to be copied (cloned) Returns: Fragment& - this instance

bool Fragment::operator== (  const Fragment &  fragment  )  const throw ()

Equality operator. Two fragments are equal if they have the same handle. See also: Object::operator ==.

void Fragment::persistentRead (  PersistenceManager &  pm  )  throw (Exception::GeneralException) [virtual]

Reads a Fragment object from a persistent stream. Parameters: pm  the persistence manager Reimplemented from AtomContainer. Reimplemented in Nucleotide, and Residue.

void Fragment::persistentWrite (  PersistenceManager &  pm, const char *  name = 0 )  const throw (Exception::GeneralException) [virtual]

Writes a Fragment object to a persistent stream. Parameters: pm  the persistence manager Reimplemented from AtomContainer. Reimplemented in Nucleotide, and Residue.