votca::csg::Residue Class Reference

class for a residue More...

#include <residue.h>

Collaboration diagram for votca::csg::Residue:

Public Member Functions
const std::string &	getName () const
	get the name of the residue
Index	getId () const
	get the name of the residue

Private Member Functions
	Residue (Index id, const std::string &name)
	constructor

Private Attributes
Index	id_
std::string	name_

Friends
class	Topology

Detailed Description

class for a residue

The Residue class describes a residue. When reading in the atoms, all beads belong to a residue. Later on, the molecules can be organized into molecules based on their residue.

Definition at line 35 of file residue.h.

Constructor & Destructor Documentation

Residue()

votca::csg::Residue::Residue ( Index id, const std::string & name )

inlineprivate

constructor

Definition at line 48 of file residue.h.

Member Function Documentation

getId()

Index votca::csg::Residue::getId ( ) const

inline

get the name of the residue

Definition at line 41 of file residue.h.

getName()

const std::string & votca::csg::Residue::getName ( ) const

inline

get the name of the residue

Definition at line 52 of file residue.h.

Friends And Related Symbol Documentation

Topology

friend class Topology

friend

Definition at line 49 of file residue.h.

Member Data Documentation

id_

Index votca::csg::Residue::id_

private

Definition at line 44 of file residue.h.

name_

std::string votca::csg::Residue::name_

private

Definition at line 45 of file residue.h.

---

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

• csg/include/votca/csg/residue.h