ring.h

/****************************************************************************************
                                          ring.h 
                                        ----------
    copyright            : (C) 2006 Jean-Luc Perret - Pierre Mahé
    email                : jean-luc.perret@unine.ch - pierre.mahe@ensmp.fr
 ***************************************************************************************/

/****************************************************************************************
 *                                                                                      *
 *      This program 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.1 of the License, or (at your option) any later version.              *
 *                                                                                      *
 *      This program 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; if not, write to the Free Software             *
 *      Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA      *
 *                                                                                      *
 ****************************************************************************************/


#ifndef RING_H
#define RING_H

#include <vector>

#include <cerror.h>


using namespace std;

class Atom;
class Bond;


class Ring : public std::vector<Atom*>{
public:



        Ring();

        Ring( vector<Atom*>*, vector<Bond*>* );

        ~Ring();

        void addBond( Bond* aBond, bool silentError = false ) throw ( CError );

        void addAtom( Atom* anAtom, bool silentError = false ) throw ( CError );




        int getID(){ return( id ); }

        void setID( int a ){ id = a; }

        vector<Bond*>* getBonds(){ return( &bonds ); }






        bool hasAtom( Atom* anAtom );

        bool hasBond( Bond* aBond );

        bool equals( Ring* anotherRing );





        string toStringShort();

        string toString();

        void describeShort();

        void describe();



// ****************************** //
// **** DEPRECATED FUNCTIONS **** //
// ****************************** //
        //Ring( vector<Atom*>* );
        //vector<Bond*>::iterator beginBond(){ return( bonds.begin() ) ; }
        //vector<Bond*>::iterator endBond(){ return( bonds.end() ) ; }

protected:

        vector<Bond*> bonds;

        int id;

};

#endif

---