Chemical Data Processing Library C++ API - Version 1.4.0
TorsionLibrary.hpp
Go to the documentation of this file.
1 /*
2  * TorsionLibrary.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_TORSIONLIBRARY_HPP
30 #define CDPL_CONFGEN_TORSIONLIBRARY_HPP
31 
32 #include <iosfwd>
33 #include <memory>
34 
37 
38 
39 namespace CDPL
40 {
41 
42  namespace ConfGen
43  {
44 
52  {
53 
54  public:
56  typedef std::shared_ptr<TorsionLibrary> SharedPointer;
57 
62  void load(std::istream& is);
63 
68  void save(std::ostream& os) const;
69 
73  void loadDefaults();
74 
79  static void set(const SharedPointer& lib);
80 
85  static const SharedPointer& get();
86 
87  private:
88  static SharedPointer defaultLib;
89  };
90  } // namespace ConfGen
91 } // namespace CDPL
92 
93 #endif // CDPL_CONFGEN_TORSIONLIBRARY_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::ConfGen::TorsionCategory.
Represents a node of a hierarchical torsion library.
Definition: TorsionCategory.hpp:54
Data structure representing a hierarchical library of torsion rules organized into categories.
Definition: TorsionLibrary.hpp:52
static void set(const SharedPointer &lib)
Sets the globally accessible default torsion library.
std::shared_ptr< TorsionLibrary > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated TorsionLibrary instances.
Definition: TorsionLibrary.hpp:56
static const SharedPointer & get()
Returns the globally accessible default torsion library (created on first access).
void save(std::ostream &os) const
Writes the library content to the output stream os in the XML-based CDPL torsion library format.
void loadDefaults()
Loads the built-in CDPL default torsion library.
void load(std::istream &is)
Reads the library content from the input stream is in the XML-based CDPL torsion library format.
The namespace of the Chemical Data Processing Library.