Chemical Data Processing Library Python API - Version 1.4.0
Public Member Functions | Properties | List of all members
CDPL.Pharm.Feature Class Reference

Abstract base class representing a single pharmacophore feature. More...

+ Inheritance diagram for CDPL.Pharm.Feature:

Public Member Functions

None __init__ ()
 Contructs the Feature instance.
 
Pharmacophore getPharmacophore ()
 Returns the parent pharmacophore. More...
 
int getIndex ()
 Returns the index of the feature in its parent pharmacophore. More...
 
Feature assign (Feature ftr)
 Replaces the current state with a copy of the state of the Feature instance ftr. More...
 
Base.Any __getitem__ (Base.LookupKey key)
 
bool __contains__ (Base.LookupKey key)
 Returns the result of the membership test operation key in self. More...
 
None __setitem__ (Base.LookupKey key, Base.Any val)
 
bool __delitem__ (Base.LookupKey key)
 
int __len__ ()
 Returns the number of property entries. More...
 
- Public Member Functions inherited from CDPL.Base.PropertyContainer
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
int getNumProperties ()
 Returns the number of property entries. More...
 
Any getPropertyOrDefault (LookupKey key, Any def_val)
 Returns the value of the property specified by key , or the default value def_val if an entry does not exist. More...
 
list getPropertyKeys ()
 Returns a list containing the keys of the current property entries. More...
 
list getPropertyValues ()
 Returns a list containing the values of the current property entries. More...
 
list getProperties ()
 Returns a reference to itself. More...
 
None setProperty (LookupKey key, Any val)
 Sets the value of the property specified by key to val. More...
 
bool removeProperty (LookupKey key)
 Removes the entry for the property specified by key. More...
 
Any getProperty (LookupKey key, bool throw_=False)
 Returns the value of the property specified by key. More...
 
bool isPropertySet (LookupKey key)
 Tells whether or not a value has been assigned to the property specified by key. More...
 
None clearProperties ()
 Erases all container entries.
 
None addProperties (PropertyContainer cntnr)
 Adds the property entries of the PropertyContainer instance cntnr. More...
 
None copyProperties (PropertyContainer cntnr)
 Replaces the current property entries by a copy of the entries in cntnr. More...
 
None swap (PropertyContainer cntnr)
 Exchanges the property entries of this container with the ones of cntnr. More...
 
Any __getitem__ (LookupKey key)
 Returns the value of the property specified by key. More...
 
bool __contains__ (LookupKey key)
 Tells whether or not a value has been assigned to the property specified by key. More...
 
None __setitem__ (LookupKey key, Any val)
 Sets the value of the property specified by key to val. More...
 
bool __delitem__ (LookupKey key)
 Removes the entry for the property specified by key. More...
 

Properties

 pharmacophore = property(getPharmacophore)
 
 index = property(getIndex)
 
- Properties inherited from CDPL.Base.PropertyContainer
 objectID = property(getObjectID)
 
 propertyKeys = property(getPropertyKeys)
 
 propertyValues = property(getPropertyValues)
 
 properties = property(getProperties)
 
 numProperties = property(getNumProperties)
 

Detailed Description

Abstract base class representing a single pharmacophore feature.

Member Function Documentation

◆ getPharmacophore()

Pharmacophore CDPL.Pharm.Feature.getPharmacophore ( )

Returns the parent pharmacophore.

Returns
The parent pharmacophore.

◆ getIndex()

int CDPL.Pharm.Feature.getIndex ( )

Returns the index of the feature in its parent pharmacophore.

Returns
The zero-based index of the feature.

◆ assign()

Feature CDPL.Pharm.Feature.assign ( Feature  ftr)

Replaces the current state with a copy of the state of the Feature instance ftr.

Parameters
ftrThe Feature instance to copy.
Returns
self.

Reimplemented in CDPL.Pharm.BasicFeature.

◆ __contains__()

bool CDPL.Pharm.Feature.__contains__ ( Base.LookupKey  key)

Returns the result of the membership test operation key in self.

Parameters
keyThe value to test for membership.
Returns
The result of the membership test operation.

Reimplemented from CDPL.Chem.Entity3D.

◆ __len__()

int CDPL.Pharm.Feature.__len__ ( )

Returns the number of property entries.

Returns
The number of property entries.

Reimplemented from CDPL.Chem.Entity3D.