Chemical Data Processing Library Python API - Version 1.2.0
Classes | Public Member Functions | Properties | List of all members
CDPL.Chem.ChEMBLStandardizer Class Reference

Implementation of the ChEMBL structure preprocessing pipeline. More...

+ Inheritance diagram for CDPL.Chem.ChEMBLStandardizer:

Classes

class  ChangeFlags
 

Public Member Functions

None __init__ ()
 Initializes the ChEMBLStandardizer instance.
 
None __init__ (ChEMBLStandardizer standardizer)
 Initializes a copy of the ChEMBLStandardizer instance standardizer. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
ChEMBLStandardizer assign (ChEMBLStandardizer standardizer)
 Replaces the current state of self with a copy of the state of the ChEMBLStandardizer instance standardizer. More...
 
ChangeFlags standardize (Molecule mol, bool proc_excld=False)
 
ChangeFlags standardize (Molecule mol, Molecule std_mol, bool proc_excluded=False)
 
ChangeFlags getParent (Molecule mol, bool neutralize=True, bool check_exclusion=True)
 
ChangeFlags getParent (Molecule mol, Molecule parent_mol, bool neutralize=True, bool check_exclusion=True)
 

Properties

 objectID = property(getObjectID)
 

Detailed Description

Implementation of the ChEMBL structure preprocessing pipeline.

See also
[CSCP]

Constructor & Destructor Documentation

◆ __init__()

None CDPL.Chem.ChEMBLStandardizer.__init__ ( ChEMBLStandardizer  standardizer)

Initializes a copy of the ChEMBLStandardizer instance standardizer.

Parameters
standardizerThe ChEMBLStandardizer instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.Chem.ChEMBLStandardizer.getObjectID ( )

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

Different Python ChEMBLStandardizer 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 ChEMBLStandardizer 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()

ChEMBLStandardizer CDPL.Chem.ChEMBLStandardizer.assign ( ChEMBLStandardizer  standardizer)

Replaces the current state of self with a copy of the state of the ChEMBLStandardizer instance standardizer.

Parameters
standardizerThe ChEMBLStandardizer instance to copy.
Returns
self

◆ standardize() [1/2]

ChangeFlags CDPL.Chem.ChEMBLStandardizer.standardize ( Molecule  mol,
bool   proc_excld = False 
)
Parameters
mol
proc_excld
Returns

◆ standardize() [2/2]

ChangeFlags CDPL.Chem.ChEMBLStandardizer.standardize ( Molecule  mol,
Molecule  std_mol,
bool   proc_excluded = False 
)
Parameters
mol
std_mol
proc_excluded
Returns

◆ getParent() [1/2]

ChangeFlags CDPL.Chem.ChEMBLStandardizer.getParent ( Molecule  mol,
bool   neutralize = True,
bool   check_exclusion = True 
)
Parameters
mol
neutralize
check_exclusion
Returns

◆ getParent() [2/2]

ChangeFlags CDPL.Chem.ChEMBLStandardizer.getParent ( Molecule  mol,
Molecule  parent_mol,
bool   neutralize = True,
bool   check_exclusion = True 
)
Parameters
mol
parent_mol
neutralize
check_exclusion
Returns