CDPL.Biomol.ResidueDictionary Class Reference

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

Inheritance diagram for CDPL.Biomol.ResidueDictionary:

Classes
class	Entry

Public Member Functions
None	__init__ ()
	Initializes the ResidueDictionary instance.
None	__init__ (ResidueDictionary dict)
	Initializes a copy of the ResidueDictionary instance dict. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
None	addEntry (Entry entry)
bool	containsEntry (str code)
None	removeEntry (str code)
Entry	getEntry (str code)
None	clear ()
int	getNumEntries ()
list	getEntries ()
None	loadDefaults ()
ResidueDictionary	assign (ResidueDictionary dict)
	Replaces the current state of self with a copy of the state of the ResidueDictionary instance dict. More...

Static Public Member Functions
None	set (ResidueDictionary dict)
ResidueDictionary	get ()
str	getReplacedCode (str code)
str	getReplacedByCode (str code)
bool	isObsolete (str code)
str	getName (str code)
bool	isStdResidue (str code)
int	getType (str code)
Chem.MolecularGraph	getStructure (str code)

Properties
	objectID = property(getObjectID)
	numEntries = property(getNumEntries)
	entries = property(getEntries)

Detailed Description

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

Constructor & Destructor Documentation

__init__()

None CDPL.Biomol.ResidueDictionary.__init__

(

ResidueDictionary

dict

)

Initializes a copy of the ResidueDictionary instance dict.

Parameters

dict	The ResidueDictionary instance to copy.

Member Function Documentation

getObjectID()

int CDPL.Biomol.ResidueDictionary.getObjectID

(

)

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

Different Python ResidueDictionary 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 ResidueDictionary 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.

addEntry()

None CDPL.Biomol.ResidueDictionary.addEntry

(

Entry

entry

)

Parameters

entry

containsEntry()

bool CDPL.Biomol.ResidueDictionary.containsEntry

(

str

code

)

Parameters

code

Returns

removeEntry()

None CDPL.Biomol.ResidueDictionary.removeEntry

(

str

code

)

Parameters

code

getEntry()

Entry CDPL.Biomol.ResidueDictionary.getEntry

(

str

code

)

Parameters

code

Returns

getNumEntries()

int CDPL.Biomol.ResidueDictionary.getNumEntries

(

)

Returns

getEntries()

list CDPL.Biomol.ResidueDictionary.getEntries

(

)

Returns

assign()

ResidueDictionary CDPL.Biomol.ResidueDictionary.assign

(

ResidueDictionary

dict

)

Replaces the current state of self with a copy of the state of the ResidueDictionary instance dict.

Parameters

dict	The ResidueDictionary instance to copy.

Returns

self

set()

None CDPL.Biomol.ResidueDictionary.set ( ResidueDictionary  dict )

static

Parameters

dict

get()

ResidueDictionary CDPL.Biomol.ResidueDictionary.get ( )

static

Parameters

<br>

Returns

getReplacedCode()

str CDPL.Biomol.ResidueDictionary.getReplacedCode ( str  code )

static

Parameters

code

Returns

getReplacedByCode()

str CDPL.Biomol.ResidueDictionary.getReplacedByCode ( str  code )

static

Parameters

code

Returns

isObsolete()

bool CDPL.Biomol.ResidueDictionary.isObsolete ( str  code )

static

Parameters

code

Returns

getName()

str CDPL.Biomol.ResidueDictionary.getName ( str  code )

static

Parameters

code

Returns

isStdResidue()

bool CDPL.Biomol.ResidueDictionary.isStdResidue ( str  code )

static

Parameters

code

Returns

getType()

int CDPL.Biomol.ResidueDictionary.getType ( str  code )

static

Parameters

code

Returns

getStructure()

Chem.MolecularGraph CDPL.Biomol.ResidueDictionary.getStructure ( str  code )

static

Parameters

code

Returns