SimTK::ResidueInfo Class Reference

#include <Compound.h>

List of all members.

Classes
class	AtomInfo
Public Member Functions
	SimTK_DEFINE_UNIQUE_LOCAL_INDEX_TYPE (ResidueInfo, Index)
	BiopolymerResidue::Index type is an integer index into residues of a Biopolymer.
	SimTK_DEFINE_UNIQUE_LOCAL_INDEX_TYPE (ResidueInfo, AtomIndex)
	ResidueInfo (ResidueInfo::Index ix, const Compound::Name &name, const BiopolymerResidue &res, Compound::AtomIndex atomOffset, char insertionCode= ' ')
AtomIndex	addAtom (Compound::AtomIndex index, const Compound::AtomName &name)
size_t	getNumAtoms () const
const AtomInfo &	getAtomInfo (AtomIndex a) const
AtomInfo &	updAtomInfo (AtomIndex a)
const std::set< Compound::Name > &	getNames () const
const Compound::Name &	getPdbResidueName () const
const int	getPdbResidueNumber () const
const char	getPdbInsertionCode () const
Compound::AtomIndex	getAtomIndex (ResidueInfo::AtomIndex a) const
Compound::AtomIndex	getAtomIndex (Compound::AtomName a) const
const String &	getAtomName (ResidueInfo::AtomIndex a) const
const std::set < Compound::AtomName > &	getAtomSynonyms (ResidueInfo::AtomIndex a) const
const Compound::Name &	getName () const
ResidueInfo &	setPdbResidueNumber (int num)
ResidueInfo::Index	getIndex () const

---

Constructor & Destructor Documentation

SimTK::ResidueInfo::ResidueInfo	(	ResidueInfo::Index	ix,
		const Compound::Name &	name,
		const BiopolymerResidue &	res,
		Compound::AtomIndex	atomOffset,
		char	insertionCode = ' '
	)

---

Member Function Documentation

SimTK::ResidueInfo::SimTK_DEFINE_UNIQUE_LOCAL_INDEX_TYPE	(	ResidueInfo	,
		Index
	)

BiopolymerResidue::Index type is an integer index into residues of a Biopolymer.

SimTK::ResidueInfo::SimTK_DEFINE_UNIQUE_LOCAL_INDEX_TYPE	(	ResidueInfo	,
		AtomIndex
	)

AtomIndex SimTK::ResidueInfo::addAtom	(	Compound::AtomIndex	index,
		const Compound::AtomName &	name
	)		[inline]

size_t SimTK::ResidueInfo::getNumAtoms

(

)

const [inline]

const AtomInfo& SimTK::ResidueInfo::getAtomInfo

(

AtomIndex

a

)

const [inline]

AtomInfo& SimTK::ResidueInfo::updAtomInfo

(

AtomIndex

a

)

[inline]

const std::set<Compound::Name>& SimTK::ResidueInfo::getNames

(

)

const [inline]

const Compound::Name& SimTK::ResidueInfo::getPdbResidueName

(

)

const [inline]

const int SimTK::ResidueInfo::getPdbResidueNumber

(

)

const [inline]

const char SimTK::ResidueInfo::getPdbInsertionCode

(

)

const [inline]

Compound::AtomIndex SimTK::ResidueInfo::getAtomIndex

(

ResidueInfo::AtomIndex

a

)

const [inline]

Compound::AtomIndex SimTK::ResidueInfo::getAtomIndex

(

Compound::AtomName

a

)

const [inline]

const String& SimTK::ResidueInfo::getAtomName

(

ResidueInfo::AtomIndex

a

)

const [inline]

const std::set<Compound::AtomName>& SimTK::ResidueInfo::getAtomSynonyms

(

ResidueInfo::AtomIndex

a

)

const [inline]

const Compound::Name& SimTK::ResidueInfo::getName

(

)

const [inline]

ResidueInfo& SimTK::ResidueInfo::setPdbResidueNumber

(

int

num

)

[inline]

ResidueInfo::Index SimTK::ResidueInfo::getIndex

(

)

const [inline]

---

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

• Compound.h