Chemical Data Processing Library C++ API - Version 1.4.0
CIPConfigurationLabeler.hpp
Go to the documentation of this file.
1 /*
2  * CIPConfigurationLabeler.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_CIPCONFIGURATIONLABELER_HPP
30 #define CDPL_CHEM_CIPCONFIGURATIONLABELER_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  class Atom;
45  class Bond;
46  class CIPConfigurationLabelerImpl;
47 
60  {
61 
62  public:
64  typedef std::shared_ptr<CIPConfigurationLabeler> SharedPointer;
65 
70 
76 
82 
87 
92  void setup(const MolecularGraph& molgraph);
93 
99  unsigned int getLabel(const Atom& atom);
100 
106  unsigned int getLabel(const Bond& bond);
107 
114 
115  private:
116  typedef std::unique_ptr<CIPConfigurationLabelerImpl> ImplementationPointer;
117 
118  ImplementationPointer impl;
119  };
120  } // namespace Chem
121 } // namespace CDPL
122 
123 #endif // CDPL_CHEM_CIPCONFIGURATIONLABELER_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.
Abstract base class representing a chemical atom and its bonded neighborhood.
Definition: Atom.hpp:57
Abstract base class representing a chemical bond between two Chem::Atom instances.
Definition: Bond.hpp:54
Assigns Cahn-Ingold-Prelog (CIP) configuration labels to stereogenic atoms and bonds of a molecular g...
Definition: CIPConfigurationLabeler.hpp:60
CIPConfigurationLabeler(const CIPConfigurationLabeler &labeler)
Constructs a copy of the CIPConfigurationLabeler instance labeler.
CIPConfigurationLabeler & operator=(const CIPConfigurationLabeler &labeler)
Replaces the state of this labeler by a copy of the state of labeler.
void setup(const MolecularGraph &molgraph)
Prepares the labeler to assign CIP descriptors for the molecular graph molgraph.
std::shared_ptr< CIPConfigurationLabeler > SharedPointer
A reference-counted smart pointer [SHPTR] for dynamically allocated CIPConfigurationLabeler instances...
Definition: CIPConfigurationLabeler.hpp:64
CIPConfigurationLabeler(const MolecularGraph &molgraph)
Constructs the CIPConfigurationLabeler instance and prepares it for molgraph.
unsigned int getLabel(const Atom &atom)
Returns the CIP descriptor of the stereogenic atom atom.
unsigned int getLabel(const Bond &bond)
Returns the CIP descriptor of the stereogenic bond bond.
CIPConfigurationLabeler()
Constructs the CIPConfigurationLabeler instance without an associated molecular graph.
Abstract base class for representations of a chemical structure as a graph of bonded atoms.
Definition: MolecularGraph.hpp:57
The namespace of the Chemical Data Processing Library.