Chemical Data Processing Library C++ API - Version 1.1.1
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
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< ResidueDictionarySharedPointer
 
typedef boost::transform_iterator< std::function< const Entry &(const EntryLookupTable::value_type &)>, EntryLookupTable::const_iterator > ConstEntryIterator
 

Public Member Functions

void addEntry (const Entry &entry)
 
bool containsEntry (const std::string &code) const
 
void removeEntry (const std::string &code)
 
const EntrygetEntry (const std::string &code) const
 
void clear ()
 
std::size_t getNumEntries () const
 
ConstEntryIterator getEntriesBegin () const
 
ConstEntryIterator getEntriesEnd () const
 
ConstEntryIterator begin () const
 
ConstEntryIterator end () const
 
void loadDefaults ()
 

Static Public Member Functions

static void set (const SharedPointer &dict)
 
static const SharedPointerget ()
 
static const std::string & getReplacedCode (const std::string &code)
 
static const std::string & getReplacedByCode (const std::string &code)
 
static bool isObsolete (const std::string &code)
 
static const std::string & getName (const std::string &code)
 
static bool isStdResidue (const std::string &code)
 
static unsigned int getType (const std::string &code)
 
static Chem::MolecularGraph::SharedPointer getStructure (const std::string &code)
 

Detailed Description

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

Member Typedef Documentation

◆ SharedPointer

◆ ConstEntryIterator

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

Member Function Documentation

◆ addEntry()

void CDPL::Biomol::ResidueDictionary::addEntry ( const Entry entry)

◆ 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

◆ 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

◆ getReplacedCode()

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

◆ getReplacedByCode()

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

◆ isObsolete()

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

◆ getName()

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

◆ isStdResidue()

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

◆ getType()

static unsigned int CDPL::Biomol::ResidueDictionary::getType ( const std::string &  code)
static

◆ getStructure()

static Chem::MolecularGraph::SharedPointer CDPL::Biomol::ResidueDictionary::getStructure ( const std::string &  code)
static

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