#include <ResidueDictionary.hpp>

Public Types
typedef std::function< Chem::MolecularGraph::SharedPointer(const std::string &)>	StructureRetrievalFunction

Public Member Functions
	Entry (const std::string &code, const std::string &rep_code, const std::string &rep_by_code, const std::string &parent_code, const std::string &one_letter_code, bool obsolete, const std::string &name, unsigned int type, const StructureRetrievalFunction &struc_ret_func)
	Constructs and initializes a `Entry` instance with the given data. More...

	Entry ()

const std::string &	getCode () const

const std::string &	getReplacedCode () const

const std::string &	getReplacedByCode () const

const std::string &	getParentCode () const

const std::string &	getOneLetterCode () const

bool	isObsolete () const

const std::string &	getName () const

unsigned int	getType () const

Chem::MolecularGraph::SharedPointer	getStructure () const

Member Typedef Documentation

◆ StructureRetrievalFunction

typedef std::function<Chem::MolecularGraph::SharedPointer(const std::string&)> CDPL::Biomol::ResidueDictionary::Entry::StructureRetrievalFunction

Constructor & Destructor Documentation

◆ Entry() [1/2]

CDPL::Biomol::ResidueDictionary::Entry::Entry	(	const std::string &	code,
		const std::string &	rep_code,
		const std::string &	rep_by_code,
		const std::string &	parent_code,
		const std::string &	one_letter_code,
		bool	obsolete,
		const std::string &	name,
		unsigned int	type,
		const StructureRetrievalFunction &	struc_ret_func
	)

Constructs and initializes a Entry instance with the given data.

Parameters

code	The three letter code (TLC) of the residue.
rep_code
rep_by_code
parent_code	The TLC of the parent residue (since 1.2).
one_letter_code	The one letter code (since 1.2).
obsolete
name
type
struc_ret_func

◆ Entry() [2/2]

CDPL::Biomol::ResidueDictionary::Entry::Entry ( )

Member Function Documentation

◆ getCode()

const std::string& CDPL::Biomol::ResidueDictionary::Entry::getCode ( ) const

◆ getReplacedCode()

const std::string& CDPL::Biomol::ResidueDictionary::Entry::getReplacedCode ( ) const

◆ getReplacedByCode()

const std::string& CDPL::Biomol::ResidueDictionary::Entry::getReplacedByCode ( ) const

◆ getParentCode()

const std::string& CDPL::Biomol::ResidueDictionary::Entry::getParentCode ( ) const

Since: 1.2

◆ getOneLetterCode()

const std::string& CDPL::Biomol::ResidueDictionary::Entry::getOneLetterCode ( ) const

Since: 1.2

◆ isObsolete()

bool CDPL::Biomol::ResidueDictionary::Entry::isObsolete ( ) const

◆ getName()

const std::string& CDPL::Biomol::ResidueDictionary::Entry::getName ( ) const

◆ getType()

unsigned int CDPL::Biomol::ResidueDictionary::Entry::getType ( ) const

◆ getStructure()

Chem::MolecularGraph::SharedPointer CDPL::Biomol::ResidueDictionary::Entry::getStructure ( ) const

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

ResidueDictionary.hpp

Public Types

Public Member Functions