Chemical Data Processing Library C++ API - Version 1.4.0
FeatureGenerator.hpp
Go to the documentation of this file.
1 /*
2  * FeatureGenerator.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_FEATUREGENERATOR_HPP
30 #define CDPL_PHARM_FEATUREGENERATOR_HPP
31 
32 #include <memory>
33 
34 #include "CDPL/Pharm/APIPrefix.hpp"
36 #include "CDPL/Math/Vector.hpp"
37 
38 
39 namespace CDPL
40 {
41 
42  namespace Chem
43  {
44 
45  class MolecularGraph;
46  };
47 
48  namespace Pharm
49  {
50 
51  class Pharmacophore;
52 
58  {
59 
60  public:
64  typedef std::shared_ptr<FeatureGenerator> SharedPointer;
65 
70 
74  virtual ~FeatureGenerator() {}
75 
81 
87 
93  virtual void generate(const Chem::MolecularGraph& molgraph, Pharmacophore& pharm) = 0;
94 
99  virtual SharedPointer clone() const = 0;
100 
101  protected:
107 
114 
115  private:
117  };
118  } // namespace Pharm
119 } // namespace CDPL
120 
121 #endif // CDPL_PHARM_FEATUREGENERATOR_HPP
Type declaration of a generic wrapper class for storing user-defined Chem::Atom 3D coordinates functi...
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.
Definition of vector data types.
Abstract base class for data structures that represent chemical structures as molecular graphs.
Definition: MolecularGraph.hpp:60
Abstract base class for generators that perceive one type of pharmacophore feature (e....
Definition: FeatureGenerator.hpp:58
FeatureGenerator & operator=(const FeatureGenerator &gen)
Copy assignment operator.
FeatureGenerator(const FeatureGenerator &gen)
Constructs a copy of the FeatureGenerator instance gen.
virtual void generate(const Chem::MolecularGraph &molgraph, Pharmacophore &pharm)=0
Perceives pharmacophore features and adds them to the pharmacophore pharm.
virtual SharedPointer clone() const =0
Creates a deep copy of the FeatureGenerator instance.
virtual ~FeatureGenerator()
Virtual destructor.
Definition: FeatureGenerator.hpp:74
virtual void setAtom3DCoordinatesFunction(const Chem::Atom3DCoordinatesFunction &func)
Specifies a function for the retrieval of atom 3D coordinates.
std::shared_ptr< FeatureGenerator > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated FeatureGenerator instances.
Definition: FeatureGenerator.hpp:64
const Chem::Atom3DCoordinatesFunction & getAtom3DCoordinatesFunction() const
Returns the function that was registered for the retrieval of atom 3D coordinates.
FeatureGenerator()
Constructs the FeatureGenerator instance.
Abstract base class for mutable containers of Pharm::Feature instances representing a pharmacophore m...
Definition: Pharmacophore.hpp:52
std::function< const Math::Vector3D &(const Chem::Atom &)> Atom3DCoordinatesFunction
Generic wrapper class used to store a user-defined Chem::Atom 3D coordinates function.
Definition: Atom3DCoordinatesFunction.hpp:43
The namespace of the Chemical Data Processing Library.