Chemical Data Processing Library C++ API - Version 1.2.0
Feature.hpp
Go to the documentation of this file.
1 /*
2  * Feature.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_FEATURE_HPP
30 #define CDPL_PHARM_FEATURE_HPP
31 
32 #include "CDPL/Pharm/APIPrefix.hpp"
33 #include "CDPL/Chem/Entity3D.hpp"
34 
35 
36 namespace CDPL
37 {
38 
39  namespace Pharm
40  {
41 
42  class Pharmacophore;
43 
48  {
49 
50  public:
55  virtual const Pharmacophore& getPharmacophore() const = 0;
56 
62 
67  virtual std::size_t getIndex() const = 0;
68 
74  Feature& operator=(const Feature& feature);
75 
76  protected:
80  virtual ~Feature() {}
81  };
82  } // namespace Pharm
83 } // namespace CDPL
84 
85 #endif // CDPL_PHARM_FEATURE_HPP
Definition of the class CDPL::Chem::Entity3D.
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.
Entity3D.
Definition: Entity3D.hpp:46
Feature.
Definition: Feature.hpp:48
virtual ~Feature()
Virtual destructor.
Definition: Feature.hpp:80
virtual const Pharmacophore & getPharmacophore() const =0
Returns a const reference to the parent pharmacophore.
virtual std::size_t getIndex() const =0
Returns the index of the feature in its parent pharmacophore.
virtual Pharmacophore & getPharmacophore()=0
Returns a non-const reference to the parent pharmacophore.
Feature & operator=(const Feature &feature)
Assignment operator that replaces the current set of properties with the properties of feature;.
Pharmacophore.
Definition: Pharmacophore.hpp:48
The namespace of the Chemical Data Processing Library.