CDPL.Biomol.ResidueDictionary.Entry Class Reference

A single residue dictionary entry. More...

Inheritance diagram for CDPL.Biomol.ResidueDictionary.Entry:

Public Member Functions
None	__init__ ()
	Constructs an empty (default-initialized) Entry instance.
None	__init__ (Entry entry)
	Initializes a copy of the Entry instance entry. More...
None	__init__ (str code, str rep_code, str rep_by_code, str parent_code, str one_letter_code, bool obsolete, str name, int type, MolecularGraphPointerStringFunctor struc_ret_func)
	Constructs and initializes an Entry instance with the given data. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
Entry	assign (Entry entry)
	Replaces the current state of self with a copy of the state of the Entry instance entry. More...
str	getCode ()
	Returns the three-letter code (TLC) of the residue. More...
str	getReplacedCode ()
	Returns the TLC of the residue this entry replaces. More...
str	getReplacedByCode ()
	Returns the TLC of the residue that replaces this one. More...
str	getParentCode ()
	Returns the TLC of the parent residue. More...
str	getOneLetterCode ()
	Returns the one-letter residue code. More...
int	getType ()
	Returns the residue type (see Biomol.ResidueType). More...
str	getName ()
	Returns the full residue name. More...
bool	isObsolete ()
	Tells whether the residue type described by this entry is obsolete. More...
Chem.MolecularGraph	getStructure ()
	Retrieves the residue structure via the configured structure-retrieval function. More...

Properties
	objectID = property(getObjectID)
	code = property(getCode)
	replacedCode = property(getReplacedCode)
	replacedByCode = property(getReplacedByCode)
	parentCode = property(getParentCode)
	oneLetterCode = property(getOneLetterCode)
	obsolete = property(isObsolete)
	name = property(getName)
	type = property(getType)
	structure = property(getStructure)

Detailed Description

A single residue dictionary entry.

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Biomol.ResidueDictionary.Entry.__init__

(

Entry

entry

)

Initializes a copy of the Entry instance entry.

Parameters

entry

The Entry instance to copy.

__init__() [2/2]

None CDPL.Biomol.ResidueDictionary.Entry.__init__	(	str	code,
		str	rep_code,
		str	rep_by_code,
		str	parent_code,
		str	one_letter_code,
		bool	obsolete,
		str	name,
		int	type,
		MolecularGraphPointerStringFunctor	struc_ret_func
	)

Constructs and initializes an Entry instance with the given data.

Parameters

code	The three-letter code (TLC) of the residue.
rep_code	The TLC of the residue this entry replaces (or an empty string if it does not replace any other residue).
rep_by_code	The TLC of the residue that replaces this one (or an empty string if it has not been replaced).
parent_code	The TLC of the parent residue (or an empty string if there is no parent).
one_letter_code	The one-letter residue code (or an empty string if not defined).
obsolete	True if the residue type is obsolete, and False otherwise.
name	The full residue name.
type	The residue type (see Biomol.ResidueType).
struc_ret_func	The function used to retrieve the residue structure on demand.

Member Function Documentation

getObjectID()

int CDPL.Biomol.ResidueDictionary.Entry.getObjectID

(

)

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python Entry instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b thus cannot tell reliably whether the two Entry instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID().

Returns

The numeric ID of the internally referenced C++ class instance.

assign()

Entry CDPL.Biomol.ResidueDictionary.Entry.assign

(

Entry

entry

)

Replaces the current state of self with a copy of the state of the Entry instance entry.

Parameters

entry

The Entry instance to copy.

Returns

self

getCode()

str CDPL.Biomol.ResidueDictionary.Entry.getCode

(

)

Returns the three-letter code (TLC) of the residue.

Returns

A reference to the three-letter residue code.

getReplacedCode()

str CDPL.Biomol.ResidueDictionary.Entry.getReplacedCode

(

)

Returns the TLC of the residue this entry replaces.

Returns

A reference to the replaced-residue code (or an empty string if this entry does not replace any other residue).

getReplacedByCode()

str CDPL.Biomol.ResidueDictionary.Entry.getReplacedByCode

(

)

Returns the TLC of the residue that replaces this one.

Returns

A reference to the replacing-residue code (or an empty string if this entry has not been replaced).

getParentCode()

str CDPL.Biomol.ResidueDictionary.Entry.getParentCode

(

)

Returns the TLC of the parent residue.

Returns

A reference to the parent-residue code (or an empty string if there is no parent).

Since

1.2

getOneLetterCode()

str CDPL.Biomol.ResidueDictionary.Entry.getOneLetterCode

(

)

Returns the one-letter residue code.

Returns

A reference to the one-letter residue code (or an empty string if not defined).

Since

1.2

getType()

int CDPL.Biomol.ResidueDictionary.Entry.getType

(

)

Returns the residue type (see Biomol.ResidueType).

Returns

The residue type identifier.

getName()

str CDPL.Biomol.ResidueDictionary.Entry.getName

(

)

Returns the full residue name.

Returns

A reference to the residue name.

isObsolete()

bool CDPL.Biomol.ResidueDictionary.Entry.isObsolete

(

)

Tells whether the residue type described by this entry is obsolete.

Returns

True if the residue type is obsolete, and False otherwise.

getStructure()

Chem.MolecularGraph CDPL.Biomol.ResidueDictionary.Entry.getStructure

(

)

Retrieves the residue structure via the configured structure-retrieval function.

Returns

A shared reference to the residue structure (or an empty reference if no structure could be retrieved).