StereoDescriptor.hpp

Go to the documentation of this file.

/* 
 * StereoDescriptor.hpp 
 *
 * This file is part of the Chemical Data Processing Toolkit
 *
 * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
 
#ifndef CDPL_CHEM_STEREODESCRIPTOR_HPP
#define CDPL_CHEM_STEREODESCRIPTOR_HPP
 
#include <cstddef>
 
#include "CDPL/Chem/APIPrefix.hpp"
 
 
namespace CDPL
{
 
    namespace Chem
    {
 
        class Atom;
        class Bond;
 
        class CDPL_CHEM_API StereoDescriptor
        {
 
          public:
            StereoDescriptor(unsigned int config);
 
            StereoDescriptor(const StereoDescriptor& descr);
 
            StereoDescriptor(unsigned int config, const Atom& atom1,
                             const Atom& atom2, const Atom& atom3);
 
            StereoDescriptor(unsigned int config, const Atom& atom1, const Atom& atom2,
                             const Atom& atom3, const Atom& atom4);
 
            std::size_t getNumReferenceAtoms() const;
 
            unsigned int getConfiguration() const;
 
            void setConfiguration(unsigned int config);
 
            const Atom* const* getReferenceAtoms() const;
 
            StereoDescriptor& operator=(const StereoDescriptor& descr);
 
            bool isValid(const Atom& atom) const;
 
            bool isValid(const Bond& bond) const;
 
            unsigned int getPermutationParity(const Atom& atom1, const Atom& atom2,
                                              const Atom& atom3) const;
 
            unsigned int getPermutationParity(const Atom& atom1, const Atom& atom2,
                                              const Atom& atom3, const Atom& atom4) const;
 
          private:
            const Atom*  refAtoms[4];
            std::size_t  numRefAtoms;
            unsigned int config;
        };
    } // namespace Chem
} // namespace CDPL
 
#endif // CDPL_CHEM_STEREODESCRIPTOR_HPP