gcu/bond.h

00001 // -*- C++ -*-
00002 
00003 /* 
00004  * Gnome Chemistry Utils
00005  * bond.h 
00006  *
00007  * Copyright (C) 2002-2004 Jean Bréfort <jean.brefort@normalesup.org>
00008  *
00009  * This program is free software; you can redistribute it and/or 
00010  * modify it under the terms of the GNU General Public License as 
00011  * published by the Free Software Foundation; either version 2 of the
00012  * License, or (at your option) any later version.
00013  *
00014  * This program is distributed in the hope that it will be useful,
00015  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017  * GNU General Public License for more details.
00018  *
00019  * You should have received a copy of the GNU General Public License
00020  * along with this program; if not, write to the Free Software
00021  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
00022  * USA
00023  */
00024 
00025 #ifndef GCU_BOND_H
00026 #define GCU_BOND_H
00027 
00028 #include <list>
00029 #include "object.h"
00030 
00031 namespace gcu
00032 {
00033 
00034 class Atom;
00035 class Cycle;
00036 
00041 class Bond: public Object
00042 {
00043 public:
00047         Bond ();
00056         Bond (Atom* first, Atom* last, unsigned char order);
00060         virtual ~Bond ();
00061         
00067         virtual Atom* GetAtom (int which); //0 = first, 1 = last, others reserved (for multicentered bonds?)
00074         virtual Atom* GetAtom (Atom* pAtom, int which = 0);     //"which" is just a place holder for multicenter bonds; returns an atom different from pAtom
00075                                                                                                                         //i.e. the other end of the bond
00079         unsigned char GetOrder ();
00085         void SetOrder (unsigned char Order);
00090         virtual xmlNodePtr Save (xmlDocPtr xml);
00096         virtual bool Load (xmlNodePtr node);
00102         virtual void IncOrder (int n = 1);
00109         virtual bool LoadNode (xmlNodePtr node);
00117         virtual bool SaveNode (xmlDocPtr xml, xmlNodePtr node);
00125         virtual void Move (double x, double y, double z = 0.);
00133         virtual void Transform2D (Matrix2D& m, double x, double y);
00134 
00135         bool SetProperty (unsigned property, char const *value);
00136         virtual void AddCycle (Cycle* pCycle);
00137         virtual void RemoveCycle (Cycle* pCycle);
00138         virtual void RemoveAllCycles ();
00139         unsigned IsCyclic () {return m_Cycles.size ();}
00140         Cycle* GetFirstCycle (std::list<Cycle*>::iterator& i, Cycle * pCycle);
00141         Cycle* GetNextCycle (std::list<Cycle*>::iterator& i, Cycle * pCycle);
00142         bool IsInCycle (Cycle* pCycle);
00143         double Get2DLength ();
00144         double GetAngle2DRad (Atom* pAtom);
00145 
00146 protected:
00150         unsigned char m_order;
00154         Atom *m_Begin;
00158         Atom *m_End;// only 2 centered bonds, other bonds should be covered by derived classes
00159 
00160         std::list<Cycle*> m_Cycles;
00161 };
00162 
00163 } // namespace gcu
00164 
00165 #endif // GCU_BOND_H

Generated on Tue Mar 18 16:06:03 2008 for The Gnome Chemistry Utils by  doxygen 1.5.5