Chemical Data Processing Library Python API - Version 1.2.0
Public Member Functions | Static Public Attributes | Properties | List of all members
CDPL.Pharm.XBondingInteractionConstraint Class Reference

XBondingInteractionConstraint. More...

+ Inheritance diagram for CDPL.Pharm.XBondingInteractionConstraint:

Public Member Functions

None __init__ (XBondingInteractionConstraint constr)
 Initializes a copy of the XBondingInteractionConstraint instance constr. More...
 
None __init__ (bool don_acc, float min_ax_dist=1.6, float max_ax_dist=1.6, float min_axb_ang=135.0, float max_acc_ang=45.0)
 Constructs a XBondingInteractionConstraint functor with the specified constraints. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
float getMinAXDistance ()
 
float getMaxAXDistance ()
 
float getMinAXBAngle ()
 
float getMaxAcceptorAngle ()
 
XBondingInteractionConstraint assign (XBondingInteractionConstraint constr)
 Replaces the current state of self with a copy of the state of the XBondingInteractionConstraint instance constr. More...
 
bool __call__ (Feature ftr1, Feature ftr2)
 

Static Public Attributes

float DEF_MIN_AX_DISTANCE = 1.6
 
float DEF_MAX_AX_DISTANCE = 3.75
 
float DEF_MIN_AXB_ANGLE = 135.0
 
float DEF_MAX_ACC_ANGLE = 45.0
 

Properties

 objectID = property(getObjectID)
 
 minAXDistance = property(getMinAXDistance)
 
 maxAXDistance = property(getMaxAXDistance)
 
 minAXBAngle = property(getMinAXBAngle)
 
 maxAcceptorAngle = property(getMaxAcceptorAngle)
 

Detailed Description

XBondingInteractionConstraint.

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Pharm.XBondingInteractionConstraint.__init__ ( XBondingInteractionConstraint  constr)

Initializes a copy of the XBondingInteractionConstraint instance constr.

Parameters
constrThe XBondingInteractionConstraint instance to copy.

◆ __init__() [2/2]

None CDPL.Pharm.XBondingInteractionConstraint.__init__ ( bool  don_acc,
float   min_ax_dist = 1.6,
float   max_ax_dist = 1.6,
float   min_axb_ang = 135.0,
float   max_acc_ang = 45.0 
)

Constructs a XBondingInteractionConstraint functor with the specified constraints.

Parameters
don_accTrue if the first feature argument represents the donor- and the second one the acceptor-feature, and False otherwise.
min_ax_distThe minimum allowed distance between the halogen-atom and the acceptor-feature.
max_ax_distThe maximum allowed distance between the halogen-atom and the acceptor-feature.
min_axb_angThe minimum allowed angle between the vectors halogen->acceptor snd halogen->bound atom.
max_acc_angThe maximum allowed angle deviation from the acceptor's preferred X-bonding direction.

Member Function Documentation

◆ getObjectID()

int CDPL.Pharm.XBondingInteractionConstraint.getObjectID ( )

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

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

◆ getMinAXDistance()

float CDPL.Pharm.XBondingInteractionConstraint.getMinAXDistance ( )
Returns

◆ getMaxAXDistance()

float CDPL.Pharm.XBondingInteractionConstraint.getMaxAXDistance ( )
Returns

◆ getMinAXBAngle()

float CDPL.Pharm.XBondingInteractionConstraint.getMinAXBAngle ( )
Returns

◆ getMaxAcceptorAngle()

float CDPL.Pharm.XBondingInteractionConstraint.getMaxAcceptorAngle ( )
Returns

◆ assign()

XBondingInteractionConstraint CDPL.Pharm.XBondingInteractionConstraint.assign ( XBondingInteractionConstraint  constr)

Replaces the current state of self with a copy of the state of the XBondingInteractionConstraint instance constr.

Parameters
constrThe XBondingInteractionConstraint instance to copy.
Returns
self

◆ __call__()

bool CDPL.Pharm.XBondingInteractionConstraint.__call__ ( Feature  ftr1,
Feature  ftr2 
)
Parameters
ftr1
ftr2
Returns