Chemical Data Processing Library C++ API - Version 1.4.0
CationPiInteractionConstraint.hpp
Go to the documentation of this file.
1 /*
2  * CationPiInteractionConstraint.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_CATIONPIINTERACTIONCONSTRAINT_HPP
30 #define CDPL_PHARM_CATIONPIINTERACTIONCONSTRAINT_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_DISTANCE = 3.5;
54  static constexpr double DEF_MAX_DISTANCE = 5.5;
56  static constexpr double DEF_MAX_ANGLE = 45.0;
57 
66  CationPiInteractionConstraint(bool aro_cat, double min_dist = DEF_MIN_DISTANCE, double max_dist = DEF_MAX_DISTANCE,
67  double max_ang = DEF_MAX_ANGLE):
68  aroCatOrder(aro_cat),
69  minDist(min_dist), maxDist(max_dist), maxAngle(max_ang) {}
70 
75  double getMinDistance() const;
76 
81  double getMaxDistance() const;
82 
87  double getMaxAngle() const;
88 
95  bool operator()(const Feature& ftr1, const Feature& ftr2) const;
96 
97  private:
98  bool aroCatOrder;
99  double minDist;
100  double maxDist;
101  double maxAngle;
102  };
103  } // namespace Pharm
104 } // namespace CDPL
105 
106 #endif // CDPL_PHARM_CATIONPIINTERACTIONCONSTRAINT_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.
Constraint functor that tests whether an aromatic/cationic feature pair satisfies the geometric crite...
Definition: CationPiInteractionConstraint.hpp:48
double getMaxDistance() const
Returns the currently configured maximum cation-aromatic distance.
CationPiInteractionConstraint(bool aro_cat, double min_dist=DEF_MIN_DISTANCE, double max_dist=DEF_MAX_DISTANCE, double max_ang=DEF_MAX_ANGLE)
Constructs a CationPiInteractionConstraint functor with the specified constraints.
Definition: CationPiInteractionConstraint.hpp:66
double getMaxAngle() const
Returns the currently configured maximum angle between cation displacement and aromatic-plane normal.
double getMinDistance() const
Returns the currently configured minimum cation-aromatic distance.
bool operator()(const Feature &ftr1, const Feature &ftr2) const
Tests whether ftr1 and ftr2 satisfy the geometric cation-π criteria.
Abstract base class representing a single pharmacophore feature within a parent Pharm::Pharmacophore.
Definition: Feature.hpp:48
The namespace of the Chemical Data Processing Library.