Chemical Data Processing Library C++ API - Version 1.1.1
AtomConformer3DCoordinatesFunctor.hpp
Go to the documentation of this file.
1 /*
2  * AtomConformer3DCoordinatesFunctor.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_ATOMCONFORMER3DCOORDINATESFUNCTOR_HPP
30 #define CDPL_CHEM_ATOMCONFORMER3DCOORDINATESFUNCTOR_HPP
31 
32 #include <cstddef>
33 
34 #include "CDPL/Chem/APIPrefix.hpp"
35 #include "CDPL/Math/Vector.hpp"
36 
37 
38 namespace CDPL
39 {
40 
41  namespace Chem
42  {
43 
44  class Atom;
45 
50  {
51 
52  public:
53  AtomConformer3DCoordinatesFunctor(std::size_t conf_idx):
54  confIndex(conf_idx) {}
55 
62  const Math::Vector3D& operator()(const Atom& atom) const;
63 
64  private:
65  std::size_t confIndex;
66  };
67  } // namespace Chem
68 } // namespace CDPL
69 
70 #endif // CDPL_CHEM_ATOMCONFORMER3DCOORDINATESFUNCTOR_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::Math::Vector3D
CVector< double, 3 > Vector3D
A bounded 3 element vector holding floating point values of type double.
Definition: Vector.hpp:1637
CDPL::Chem::Atom
Atom.
Definition: Atom.hpp:52
CDPL::Chem::AtomConformer3DCoordinatesFunctor
AtomConformer3DCoordinatesFunctor.
Definition: AtomConformer3DCoordinatesFunctor.hpp:50
CDPL::Chem::AtomConformer3DCoordinatesFunctor::operator()
const Math::Vector3D & operator()(const Atom &atom) const
Returns the 3D-coordinates of the argument atom.
CDPL::Chem::AtomConformer3DCoordinatesFunctor::AtomConformer3DCoordinatesFunctor
AtomConformer3DCoordinatesFunctor(std::size_t conf_idx)
Definition: AtomConformer3DCoordinatesFunctor.hpp:53
CDPL
The namespace of the Chemical Data Processing Library.
Vector.hpp
Definition of vector data types.