Chemical Data Processing Library C++ API - Version 1.4.0
TorsionRuleMatch.hpp
Go to the documentation of this file.
1 /*
2  * TorsionRuleMatch.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_CONFGEN_TORSIONRULEMATCH_HPP
30 #define CDPL_CONFGEN_TORSIONRULEMATCH_HPP
31 
32 #include <vector>
33 #include <cstddef>
34 
37 
38 
39 namespace CDPL
40 {
41 
42  namespace Chem
43  {
44 
45  class Atom;
46  class Bond;
47  } // namespace Chem
48 
49  namespace ConfGen
50  {
51 
52  class TorsionRule;
53 
58  {
59 
60  public:
70  TorsionRuleMatch(const TorsionRule& rule, const Chem::Bond& bond,
71  const Chem::Atom* atom1, const Chem::Atom* atom2,
72  const Chem::Atom* atom3, const Chem::Atom* atom4);
73 
78  const Chem::Atom* const* getAtoms() const;
79 
84  const TorsionRule& getRule() const;
85 
90  const Chem::Bond& getBond() const;
91 
92  private:
93  const TorsionRule* rule;
94  const Chem::Bond* bond;
95  const Chem::Atom* atoms[4];
96  };
97  } // namespace ConfGen
98 } // namespace CDPL
99 
100 #endif // CDPL_CONFGEN_TORSIONRULEMATCH_HPP
Definition of the preprocessor macro CDPL_CONFGEN_API.
#define CDPL_CONFGEN_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Definition of class CDPL::Chem::MolecularGraph.
Abstract base class representing a chemical atom and its bonded neighborhood.
Definition: Atom.hpp:57
Abstract base class representing a chemical bond between two Chem::Atom instances.
Definition: Bond.hpp:54
A single match of a ConfGen::TorsionRule against a rotatable bond: the rule, the bond and the four at...
Definition: TorsionRuleMatch.hpp:58
TorsionRuleMatch(const TorsionRule &rule, const Chem::Bond &bond, const Chem::Atom *atom1, const Chem::Atom *atom2, const Chem::Atom *atom3, const Chem::Atom *atom4)
Constructs the TorsionRuleMatch instance.
const Chem::Atom *const * getAtoms() const
Returns the four torsion atoms (A, B, C, D).
const TorsionRule & getRule() const
Returns the matched torsion rule.
const Chem::Bond & getBond() const
Returns the rotatable bond at which the rule matched.
Data structure for the representation of single torsion library rules.
Definition: TorsionRule.hpp:53
The namespace of the Chemical Data Processing Library.