CDPL::Biomol::ResidueDictionary Class Reference

A global dictionary for the lookup of meta-data associated with the residues in biological macromolecules. More...

#include <ResidueDictionary.hpp>

Classes
class	Entry

Public Types
typedef std::shared_ptr< ResidueDictionary >	SharedPointer
typedef boost::transform_iterator< std::function< const Entry &(const EntryLookupTable::value_type &)>, EntryLookupTable::const_iterator >	ConstEntryIterator

Public Member Functions
void	addEntry (const Entry &entry)
void	addEntry (Entry &&entry)
bool	containsEntry (const std::string &code) const
void	removeEntry (const std::string &code)
const Entry &	getEntry (const std::string &code) const
void	clear ()
std::size_t	getNumEntries () const
ConstEntryIterator	getEntriesBegin () const
ConstEntryIterator	getEntriesEnd () const
ConstEntryIterator	begin () const
ConstEntryIterator	end () const
const std::string &	getReplacedCode (const std::string &code) const
const std::string &	getReplacedByCode (const std::string &code) const
const std::string &	getParentCode (const std::string &code) const
const std::string &	getOneLetterCode (const std::string &code) const
bool	isObsolete (const std::string &code) const
const std::string &	getName (const std::string &code) const
unsigned int	getType (const std::string &code) const
Chem::MolecularGraph::SharedPointer	getStructure (const std::string &code) const
void	loadDefaults ()

Static Public Member Functions
static bool	isStdResidue (const std::string &code)
static void	set (const SharedPointer &dict)
static const SharedPointer &	get ()

Detailed Description

A global dictionary for the lookup of meta-data associated with the residues in biological macromolecules.

Member Typedef Documentation

SharedPointer

typedef std::shared_ptr<ResidueDictionary> CDPL::Biomol::ResidueDictionary::SharedPointer

ConstEntryIterator

typedef boost::transform_iterator<std::function<const Entry&(const EntryLookupTable::value_type&)>, EntryLookupTable::const_iterator> CDPL::Biomol::ResidueDictionary::ConstEntryIterator

Member Function Documentation

isStdResidue()

static bool CDPL::Biomol::ResidueDictionary::isStdResidue ( const std::string &  code )

static

addEntry() [1/2]

void CDPL::Biomol::ResidueDictionary::addEntry

(

const Entry &

entry

)

addEntry() [2/2]

void CDPL::Biomol::ResidueDictionary::addEntry

(

Entry &&

entry

)

Since

1.2

containsEntry()

bool CDPL::Biomol::ResidueDictionary::containsEntry

(

const std::string &

code

)

const

removeEntry()

void CDPL::Biomol::ResidueDictionary::removeEntry

(

const std::string &

code

)

getEntry()

const Entry& CDPL::Biomol::ResidueDictionary::getEntry

(

const std::string &

code

)

const

clear()

void CDPL::Biomol::ResidueDictionary::clear

(

)

getNumEntries()

std::size_t CDPL::Biomol::ResidueDictionary::getNumEntries

(

)

const

getEntriesBegin()

ConstEntryIterator CDPL::Biomol::ResidueDictionary::getEntriesBegin

(

)

const

getEntriesEnd()

ConstEntryIterator CDPL::Biomol::ResidueDictionary::getEntriesEnd

(

)

const

begin()

ConstEntryIterator CDPL::Biomol::ResidueDictionary::begin

(

)

const

end()

ConstEntryIterator CDPL::Biomol::ResidueDictionary::end

(

)

const

getReplacedCode()

const std::string& CDPL::Biomol::ResidueDictionary::getReplacedCode

(

const std::string &

code

)

const

getReplacedByCode()

const std::string& CDPL::Biomol::ResidueDictionary::getReplacedByCode

(

const std::string &

code

)

const

getParentCode()

const std::string& CDPL::Biomol::ResidueDictionary::getParentCode

(

const std::string &

code

)

const

Since

1.2

getOneLetterCode()

const std::string& CDPL::Biomol::ResidueDictionary::getOneLetterCode

(

const std::string &

code

)

const

Since

1.2

isObsolete()

bool CDPL::Biomol::ResidueDictionary::isObsolete

(

const std::string &

code

)

const

getName()

const std::string& CDPL::Biomol::ResidueDictionary::getName

(

const std::string &

code

)

const

getType()

unsigned int CDPL::Biomol::ResidueDictionary::getType

(

const std::string &

code

)

const

getStructure()

Chem::MolecularGraph::SharedPointer CDPL::Biomol::ResidueDictionary::getStructure

(

const std::string &

code

)

const

loadDefaults()

void CDPL::Biomol::ResidueDictionary::loadDefaults

(

)

set()

static void CDPL::Biomol::ResidueDictionary::set ( const SharedPointer &  dict )

static

get()

static const SharedPointer& CDPL::Biomol::ResidueDictionary::get ( )

static

---

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

• ResidueDictionary.hpp