Chemical Data Processing Library C++ API - Version 1.1.1
ComponentSet.hpp
Go to the documentation of this file.
1 /*
2  * ComponentSet.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_COMPONENTSET_HPP
30 #define CDPL_CHEM_COMPONENTSET_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 
49  {
50 
51  public:
55  typedef std::shared_ptr<ComponentSet> SharedPointer;
56 
61 
66  ComponentSet(const MolecularGraph& molgraph);
67 
72  void perceive(const MolecularGraph& molgraph);
73 
74  private:
75  void visitAtom(const Atom&, Fragment&);
76 
77  const char* getClassName() const
78  {
79  return "ComponentSet";
80  }
81 
82  const MolecularGraph* molGraph;
83  Util::BitSet visAtomMask;
84  };
85  } // namespace Chem
86 } // namespace CDPL
87 
88 #endif // CDPL_CHEM_COMPONENTSET_HPP
CDPL::Chem::ComponentSet::ComponentSet
ComponentSet(const MolecularGraph &molgraph)
Constructs a ComponentSet instance that contains the componenents of the molecular graph molgraph.
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::Chem::ComponentSet::ComponentSet
ComponentSet()
Constructs an empty ComponentSet instance.
Definition: ComponentSet.hpp:60
CDPL::Util::BitSet
boost::dynamic_bitset BitSet
A dynamic bitset class.
Definition: BitSet.hpp:46
CDPL::Chem::Atom
Atom.
Definition: Atom.hpp:52
CDPL::Chem::Fragment
Fragment.
Definition: Fragment.hpp:52
CDPL::Chem::MolecularGraph
MolecularGraph.
Definition: MolecularGraph.hpp:52
CDPL::Chem::ComponentSet
Implements the perception of molecular graph components.
Definition: ComponentSet.hpp:49
BitSet.hpp
Definition of the type CDPL::Util::BitSet.
CDPL::Chem::ComponentSet::SharedPointer
std::shared_ptr< ComponentSet > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated ComponentSet instances.
Definition: ComponentSet.hpp:55
CDPL::Chem::FragmentList
A data type for the storage of Chem::Fragment objects.
Definition: FragmentList.hpp:49
CDPL::Chem::ComponentSet::perceive
void perceive(const MolecularGraph &molgraph)
Replaces the current set of components by the components of the molecular graph molgraph.
CDPL
The namespace of the Chemical Data Processing Library.
FragmentList.hpp
Definition of the class CDPL::Chem::FragmentList.