Chemical Data Processing Library C++ API - Version 1.4.0
FragmentAssemblerSettings.hpp
Go to the documentation of this file.
1 /*
2  * FragmentAssemblerSettings.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_FRAGMENTASSEMBLERSETTINGS_HPP
30 #define CDPL_CONFGEN_FRAGMENTASSEMBLERSETTINGS_HPP
31 
34 
35 
36 namespace CDPL
37 {
38 
39  namespace ConfGen
40  {
41 
46  {
47 
48  public:
51 
56 
61  void enumerateRings(bool enumerate);
62 
67  bool enumerateRings() const;
68 
73  void setNitrogenEnumerationMode(unsigned int mode);
74 
79  unsigned int getNitrogenEnumerationMode() const;
80 
85  void generateCoordinatesFromScratch(bool generate);
86 
92 
98 
104 
105  private:
106  bool enumRings;
107  unsigned int nitrogenEnumMode;
108  bool fromScratch;
109  FragmentConformerGeneratorSettings fragBuildSettings;
110  };
111  } // namespace ConfGen
112 } // namespace CDPL
113 
114 #endif // CDPL_CONFGEN_FRAGMENTASSEMBLERSETTINGS_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::FragmentConformerGeneratorSettings.
Bundle of configuration parameters for fragment conformer assembly via class ConfGen::FragmentAssembl...
Definition: FragmentAssemblerSettings.hpp:46
void setNitrogenEnumerationMode(unsigned int mode)
Sets the enumeration mode for invertible nitrogen centers.
static const FragmentAssemblerSettings DEFAULT
A static instance providing configuration parameter default values.
Definition: FragmentAssemblerSettings.hpp:50
FragmentConformerGeneratorSettings & getFragmentBuildSettings()
Returns a reference to the nested fragment conformer build settings.
unsigned int getNitrogenEnumerationMode() const
Returns the currently configured invertible nitrogen enumeration mode.
void enumerateRings(bool enumerate)
Specifies whether ring conformations shall be enumerated during fragment assembly.
const FragmentConformerGeneratorSettings & getFragmentBuildSettings() const
Returns a const reference to the nested fragment conformer build settings.
FragmentAssemblerSettings()
Constructs the FragmentAssemblerSettings instance with default configuration parameter values.
bool enumerateRings() const
Tells whether ring conformations are enumerated during fragment assembly.
void generateCoordinatesFromScratch(bool generate)
Specifies whether 3D coordinates shall be generated from scratch (ignoring any 3D input).
bool generateCoordinatesFromScratch() const
Tells whether 3D coordinates are generated from scratch.
Bundle of configuration parameters for fragment conformer ensemble generation via class ConfGen::Frag...
Definition: FragmentConformerGeneratorSettings.hpp:48
The namespace of the Chemical Data Processing Library.