Chemical Data Processing Library Python API - Version 1.1.1
Public Member Functions | Properties | List of all members
CDPL.Biomol.ResidueDictionary.Entry Class Reference
+ Inheritance diagram for CDPL.Biomol.ResidueDictionary.Entry:

Public Member Functions

None __init__ ()
 Initializes the 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, bool obsolete, str name, int type, MolecularGraphPointerStringFunctor struc_ret_func)
 Initializes the Entry instance. 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 ()
 
str getReplacedCode ()
 
str getReplacedByCode ()
 
int getType ()
 
str getName ()
 
bool isObsolete ()
 
Chem.MolecularGraph getStructure ()
 

Properties

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

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Biomol.ResidueDictionary.Entry.__init__ ( Entry  entry)

Initializes a copy of the Entry instance entry.

Parameters
entryThe Entry instance to copy.

◆ __init__() [2/2]

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

Initializes the Entry instance.

Parameters
code
rep_code
rep_by_code
obsolete
name
type
struc_ret_func

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
entryThe Entry instance to copy.
Returns
self

◆ getCode()

str CDPL.Biomol.ResidueDictionary.Entry.getCode ( )
Returns

◆ getReplacedCode()

str CDPL.Biomol.ResidueDictionary.Entry.getReplacedCode ( )
Returns

◆ getReplacedByCode()

str CDPL.Biomol.ResidueDictionary.Entry.getReplacedByCode ( )
Returns

◆ getType()

int CDPL.Biomol.ResidueDictionary.Entry.getType ( )
Returns

◆ getName()

str CDPL.Biomol.ResidueDictionary.Entry.getName ( )
Returns

◆ isObsolete()

bool CDPL.Biomol.ResidueDictionary.Entry.isObsolete ( )
Returns

◆ getStructure()

Chem.MolecularGraph CDPL.Biomol.ResidueDictionary.Entry.getStructure ( )
Returns