Chemical Data Processing Library C++ API - Version 1.4.0
HBondingInteractionConstraint.hpp
Go to the documentation of this file.
1 /*
2  * HBondingInteractionConstraint.hpp
3  *
4  * This file is part of the Chemical Data Processing Toolkit
5  *
6  * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this library; see the file COPYING. If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23 
29 #ifndef CDPL_PHARM_HBONDINGINTERACTIONCONSTRAINT_HPP
30 #define CDPL_PHARM_HBONDINGINTERACTIONCONSTRAINT_HPP
31 
32 #include "CDPL/Pharm/APIPrefix.hpp"
33 
34 
35 namespace CDPL
36 {
37 
38  namespace Pharm
39  {
40 
41  class Feature;
42 
48  {
49 
50  public:
52  static constexpr double DEF_MIN_HB_LENGTH = 1.2;
54  static constexpr double DEF_MAX_HB_LENGTH = 2.8;
56  static constexpr double DEF_MIN_AHD_ANGLE = 130.0;
58  static constexpr double DEF_MAX_ACC_ANGLE = 85.0;
59 
69  HBondingInteractionConstraint(bool don_acc, double min_len = DEF_MIN_HB_LENGTH, double max_len = DEF_MAX_HB_LENGTH,
70  double min_ahd_ang = DEF_MIN_AHD_ANGLE, double max_acc_ang = DEF_MAX_ACC_ANGLE):
71  donAccOrder(don_acc),
72  minLength(min_len), maxLength(max_len), minAHDAngle(min_ahd_ang), maxAccAngle(max_acc_ang) {}
73 
78  double getMinLength() const;
79 
84  double getMaxLength() const;
85 
90  double getMinAHDAngle() const;
91 
96  double getMaxAcceptorAngle() const;
97 
104  bool operator()(const Feature& ftr1, const Feature& ftr2) const;
105 
106  private:
107  bool donAccOrder;
108  double minLength;
109  double maxLength;
110  double minAHDAngle;
111  double maxAccAngle;
112  };
113  } // namespace Pharm
114 } // namespace CDPL
115 
116 #endif // CDPL_PHARM_HBONDINGINTERACTIONCONSTRAINT_HPP
Definition of the preprocessor macro CDPL_PHARM_API.
#define CDPL_PHARM_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Abstract base class representing a single pharmacophore feature within a parent Pharm::Pharmacophore.
Definition: Feature.hpp:48
Constraint functor that tests whether a Pharm::Feature pair satisfies geometric H-bond criteria (H-bo...
Definition: HBondingInteractionConstraint.hpp:48
double getMaxLength() const
Returns the currently configured maximum H-bond length.
HBondingInteractionConstraint(bool don_acc, double min_len=DEF_MIN_HB_LENGTH, double max_len=DEF_MAX_HB_LENGTH, double min_ahd_ang=DEF_MIN_AHD_ANGLE, double max_acc_ang=DEF_MAX_ACC_ANGLE)
Constructs a HBondingInteractionConstraint functor with the specified constraints.
Definition: HBondingInteractionConstraint.hpp:69
double getMinAHDAngle() const
Returns the currently configured minimum acceptor-hydrogen-donor angle.
bool operator()(const Feature &ftr1, const Feature &ftr2) const
Tests whether ftr1 and ftr2 satisfy the geometric H-bond constraints.
double getMaxAcceptorAngle() const
Returns the currently configured maximum H-bond direction to acceptor-vector angle.
double getMinLength() const
Returns the currently configured minimum H-bond length.
The namespace of the Chemical Data Processing Library.