Chemical Data Processing Library C++ API - Version 1.2.0
MultiConfMoleculeInputProcessor.hpp
Go to the documentation of this file.
1 /*
2  * MultiConfMoleculeInputProcessor.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_MULTICONFMOLECULEINPUTPROCESSOR_HPP
30 #define CDPL_CHEM_MULTICONFMOLECULEINPUTPROCESSOR_HPP
31 
32 #include <memory>
33 
34 #include "CDPL/Chem/APIPrefix.hpp"
35 
36 
37 namespace CDPL
38 {
39 
40  namespace Chem
41  {
42 
43  class MolecularGraph;
44 
49  {
50 
51  public:
56  typedef std::shared_ptr<MultiConfMoleculeInputProcessor> SharedPointer;
57 
64 
70  virtual bool init(MolecularGraph& tgt_molgraph) const = 0;
71 
78  virtual bool isConformation(MolecularGraph& tgt_molgraph, MolecularGraph& conf_molgraph) const = 0;
79 
87  virtual bool addConformation(MolecularGraph& tgt_molgraph, MolecularGraph& conf_molgraph) const = 0;
88  };
89  } // namespace Chem
90 } // namespace CDPL
91 
92 #endif // CDPL_CHEM_MULTICONFMOLECULEINPUTPROCESSOR_HPP
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.
MolecularGraph.
Definition: MolecularGraph.hpp:52
MultiConfMoleculeInputProcessor.
Definition: MultiConfMoleculeInputProcessor.hpp:49
virtual bool addConformation(MolecularGraph &tgt_molgraph, MolecularGraph &conf_molgraph) const =0
Tries to append a new conformation to the list of previously read-in conformers of tgt_molgraph.
virtual ~MultiConfMoleculeInputProcessor()
Virtual destructor.
Definition: MultiConfMoleculeInputProcessor.hpp:63
std::shared_ptr< MultiConfMoleculeInputProcessor > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated MultiConfMoleculeInputProcessor i...
Definition: MultiConfMoleculeInputProcessor.hpp:56
virtual bool init(MolecularGraph &tgt_molgraph) const =0
Performs initial tests and necessary setup tasks for a newly read-in potential multi-conformer molecu...
virtual bool isConformation(MolecularGraph &tgt_molgraph, MolecularGraph &conf_molgraph) const =0
Checks if conf_molgraph represents a conformation of tgt_molgraph.
The namespace of the Chemical Data Processing Library.