Chemical Data Processing Library C++ API - Version 1.4.0
DefaultMultiConfMoleculeInputProcessor.hpp
Go to the documentation of this file.
1 /*
2  * DefaultMultiConfMoleculeInputProcessor.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_DEFAULTMULTICONFMOLECULEINPUTPROCESSOR_HPP
30 #define CDPL_CHEM_DEFAULTMULTICONFMOLECULEINPUTPROCESSOR_HPP
31 
32 #include "CDPL/Chem/APIPrefix.hpp"
36 
37 
38 namespace CDPL
39 {
40 
41  namespace Chem
42  {
43 
49  {
50 
51  public:
53  typedef std::shared_ptr<DefaultMultiConfMoleculeInputProcessor> SharedPointer;
54 
56  static constexpr unsigned int DEF_ATOM_PROPERTY_FLAGS =
59 
61  static constexpr unsigned int DEF_BOND_PROPERTY_FLAGS =
63 
70  DefaultMultiConfMoleculeInputProcessor(bool comp_names = true, unsigned int atom_flags = DEF_ATOM_PROPERTY_FLAGS, unsigned int bond_flags = DEF_BOND_PROPERTY_FLAGS);
71 
77  bool init(MolecularGraph& tgt_molgraph) const;
78 
85  bool isConformation(MolecularGraph& tgt_molgraph, MolecularGraph& conf_molgraph) const;
86 
93  bool addConformation(MolecularGraph& tgt_molgraph, MolecularGraph& conf_molgraph) const;
94 
95  private:
96  bool compareNames;
97  unsigned int atomFlags;
98  unsigned int bondFlags;
99  };
100  } // namespace Chem
101 } // namespace CDPL
102 
103 #endif // CDPL_CHEM_DEFAULTMULTICONFMOLECULEINPUTPROCESSOR_HPP
Definition of constants in namespace CDPL::Chem::BondPropertyFlag.
Definition of the preprocessor macro CDPL_CHEM_API.
#define CDPL_CHEM_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Definition of constants in namespace CDPL::Chem::AtomPropertyFlag.
Definition of class CDPL::Chem::MultiConfMoleculeInputProcessor.
Default Chem::MultiConfMoleculeInputProcessor implementation that detects multi-conformer input by co...
Definition: DefaultMultiConfMoleculeInputProcessor.hpp:49
bool addConformation(MolecularGraph &tgt_molgraph, MolecularGraph &conf_molgraph) const
Adds the atom-coordinate set of conf_molgraph as a new conformer to tgt_molgraph.
DefaultMultiConfMoleculeInputProcessor(bool comp_names=true, unsigned int atom_flags=DEF_ATOM_PROPERTY_FLAGS, unsigned int bond_flags=DEF_BOND_PROPERTY_FLAGS)
Constructs the processor with the given property-comparison configuration.
bool init(MolecularGraph &tgt_molgraph) const
Initializes the processor state for tgt_molgraph as the new conformer-collection target.
bool isConformation(MolecularGraph &tgt_molgraph, MolecularGraph &conf_molgraph) const
Tells whether conf_molgraph is a conformer of the already-accumulated tgt_molgraph.
std::shared_ptr< DefaultMultiConfMoleculeInputProcessor > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated DefaultMultiConfMoleculeInputProc...
Definition: DefaultMultiConfMoleculeInputProcessor.hpp:53
Abstract base class for representations of a chemical structure as a graph of bonded atoms.
Definition: MolecularGraph.hpp:57
Abstract base interface for processors that detect and assemble multi-conformer molecules from a stre...
Definition: MultiConfMoleculeInputProcessor.hpp:50
constexpr unsigned int FORMAL_CHARGE
Specifies the formal charge of an atom.
Definition: Chem/AtomPropertyFlag.hpp:73
constexpr unsigned int ISOTOPE
Specifies the isotopic mass of an atom.
Definition: Chem/AtomPropertyFlag.hpp:68
constexpr unsigned int TYPE
Specifies the generic type or element of an atom.
Definition: Chem/AtomPropertyFlag.hpp:63
constexpr unsigned int ORDER
Specifies the order of a bond.
Definition: BondPropertyFlag.hpp:63
The namespace of the Chemical Data Processing Library.