Chemical Data Processing Library C++ API - Version 1.1.1
AromaticRingSet.hpp
Go to the documentation of this file.
1 /*
2  * AromaticRingSet.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_CHEM_AROMATICRINGSET_HPP
30 #define CDPL_CHEM_AROMATICRINGSET_HPP
31 
32 #include <memory>
33 
34 #include "CDPL/Chem/APIPrefix.hpp"
36 #include "CDPL/Util/BitSet.hpp"
37 
38 
39 namespace CDPL
40 {
41 
42  namespace Chem
43  {
44 
45  class MolecularGraph;
46 
51  {
52 
53  public:
57  typedef std::shared_ptr<AromaticRingSet> SharedPointer;
58 
63 
69  AromaticRingSet(const MolecularGraph& molgraph);
70 
75  void perceive(const MolecularGraph& molgraph);
76 
77  private:
79 
80  AromaticRingSet& operator=(const AromaticRingSet&);
81 
82  void init(const MolecularGraph&);
83 
84  void findAromaticRings();
85 
87 
88  const char* getClassName() const
89  {
90  return "AromaticRingSet";
91  }
92 
93  Util::BitSet aromBondMask;
94  const MolecularGraph* molGraph;
95  };
96  } // namespace Chem
97 } // namespace CDPL
98 
99 #endif // CDPL_CHEM_AROMATICRINGSET_HPP
APIPrefix.hpp
Definition of the preprocessor macro CDPL_CHEM_API.
CDPL_CHEM_API
#define CDPL_CHEM_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
CDPL::Util::BitSet
boost::dynamic_bitset BitSet
A dynamic bitset class.
Definition: BitSet.hpp:46
CDPL::Chem::AromaticRingSet::AromaticRingSet
AromaticRingSet()
Constructs an empty AromaticRingSet instance.
Definition: AromaticRingSet.hpp:62
CDPL::Chem::AromaticRingSet::SharedPointer
std::shared_ptr< AromaticRingSet > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated AromaticRingSet instances.
Definition: AromaticRingSet.hpp:57
CDPL::Chem::MolecularGraph
MolecularGraph.
Definition: MolecularGraph.hpp:52
BitSet.hpp
Definition of the type CDPL::Util::BitSet.
CDPL::Chem::AromaticRingSet::AromaticRingSet
AromaticRingSet(const MolecularGraph &molgraph)
Construct a AromaticRingSet instance that contains all aromatic rings of the molecular graph molgraph...
CDPL::Chem::AromaticRingSet::perceive
void perceive(const MolecularGraph &molgraph)
Replaces the current set of rings by the aromatic rings of the molecular graph molgraph.
CDPL::Chem::Fragment::SharedPointer
std::shared_ptr< Fragment > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated Fragment instances.
Definition: Fragment.hpp:61
CDPL::Chem::FragmentList
A data type for the storage of Chem::Fragment objects.
Definition: FragmentList.hpp:49
CDPL::Chem::isAromatic
CDPL_CHEM_API bool isAromatic(const Fragment &ring, const MolecularGraph &molgraph, const Util::BitSet &arom_bond_mask)
CDPL
The namespace of the Chemical Data Processing Library.
CDPL::Chem::AromaticRingSet
Implements the perception of aromatic rings in a molecular graph.
Definition: AromaticRingSet.hpp:51
FragmentList.hpp
Definition of the class CDPL::Chem::FragmentList.