Chemical Data Processing Library C++ API - Version 1.4.0
ConformerData.hpp
Go to the documentation of this file.
1 /*
2  * ConformerData.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_CONFORMERDATA_HPP
30 #define CDPL_CONFGEN_CONFORMERDATA_HPP
31 
32 #include <algorithm>
33 
36 
37 
38 namespace CDPL
39 {
40 
41  namespace ConfGen
42  {
43 
51  {
52 
53  public:
57  typedef std::shared_ptr<ConformerData> SharedPointer;
58 
63  energy(0.0) {}
64 
70  ConformerData(const Math::Vector3DArray& coords, double energy = 0.0):
71  Math::Vector3DArray(coords), energy(energy) {}
72 
77  void setEnergy(double energy)
78  {
79  this->energy = energy;
80  }
81 
86  double getEnergy() const
87  {
88  return energy;
89  }
90 
95  void swap(ConformerData& data)
96  {
97  Math::Vector3DArray::swap(data);
98  std::swap(energy, data.energy);
99  }
100 
101  private:
102  const char* getClassName() const
103  {
104  return "ConformerData";
105  }
106 
107  double energy;
108  };
109  } // namespace ConfGen
110 } // namespace CDPL
111 
112 #endif // CDPL_CONFGEN_CONFORMERDATA_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::Math::VectorArray.
Container for the 3D coordinates of a generated conformer plus its associated energy value.
Definition: ConformerData.hpp:51
void setEnergy(double energy)
Sets the energy value.
Definition: ConformerData.hpp:77
std::shared_ptr< ConformerData > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated ConformerData instances.
Definition: ConformerData.hpp:57
double getEnergy() const
Returns the energy value.
Definition: ConformerData.hpp:86
ConformerData()
Constructs an empty ConformerData instance with zero energy.
Definition: ConformerData.hpp:62
ConformerData(const Math::Vector3DArray &coords, double energy=0.0)
Constructs the ConformerData instance with the given coordinates and energy.
Definition: ConformerData.hpp:70
void swap(ConformerData &data)
Swaps the contents (coordinates and energy) of this instance with data.
Definition: ConformerData.hpp:95
VectorArray< Vector3D > Vector3DArray
Array storing vectors of type Math::Vector3D.
Definition: VectorArray.hpp:87
The namespace of the Chemical Data Processing Library.