Bond.hpp

Go to the documentation of this file.

/* 
 * Bond.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_BOND_HPP
#define CDPL_CHEM_BOND_HPP
 
#include "CDPL/Chem/APIPrefix.hpp"
#include "CDPL/Chem/AtomContainer.hpp"
#include "CDPL/Base/PropertyContainer.hpp"
 
 
namespace CDPL
{
 
    namespace Chem
    {
 
        class Molecule;
 
        class CDPL_CHEM_API Bond : public AtomContainer,
                                   public Base::PropertyContainer
        {
 
          public:
            typedef AtomContainer::AtomIterator AtomIterator;
 
            typedef AtomContainer::ConstAtomIterator ConstAtomIterator;
 
            using AtomContainer::getAtomsBegin;
            using AtomContainer::getAtomsEnd;
 
            virtual const Molecule& getMolecule() const = 0;
 
            virtual Molecule& getMolecule() = 0;
 
            virtual const Atom& getBegin() const = 0;
 
            virtual Atom& getBegin() = 0;
 
            virtual const Atom& getEnd() const = 0;
 
            virtual Atom& getEnd() = 0;
 
            virtual const Atom& getNeighbor(const Atom& atom) const = 0;
 
            virtual Atom& getNeighbor(const Atom& atom) = 0;
 
            virtual std::size_t getIndex() const = 0;
 
            virtual std::size_t getNumAtoms() const = 0;
 
            virtual const Atom& getAtom(std::size_t idx) const = 0;
 
            virtual Atom& getAtom(std::size_t idx) = 0;
 
            virtual bool containsAtom(const Atom& atom) const = 0;
 
            virtual std::size_t getAtomIndex(const Atom& atom) const = 0;
 
            Bond& operator=(const Bond& bond);
 
          protected:
            virtual ~Bond() {}
        };
    } // namespace Chem
} // namespace CDPL
 
#endif // CDPL_CHEM_BOND_HPP