reactant.h

Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 /* 
00004  * GChemPaint library
00005  * reactant.h 
00006  *
00007  * Copyright (C) 2004-2010 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 GCHEMPAINT_REACTANT_H
00026 #define GCHEMPAINT_REACTANT_H
00027 
00028 #include <gcu/object.h>
00029 
00031 namespace gcp {
00032 
00033 class ReactionStep;
00034 
00041 class Reactant: public gcu::Object
00042 {
00043 public:
00047         Reactant ();
00051         virtual ~Reactant ();
00052 
00057         Reactant (ReactionStep* step, gcu::Object* object) throw (std::invalid_argument);
00058 
00065         virtual xmlNodePtr Save (xmlDocPtr xml) const;
00073         virtual bool Load (xmlNodePtr node);
00074 
00078         unsigned GetStoichiometry () const {return m_Stoich;}
00084         void SetStoichiometry (unsigned coef) {m_Stoich = coef;}
00089         virtual double GetYAlign ();
00099         bool BuildContextualMenu (GtkUIManager *UIManager, gcu::Object *object, double x, double y);
00110         bool OnSignal (gcu::SignalId Signal, gcu::Object *Child);
00111 
00116         void AddStoichiometry ();
00120         gcu::Object *GetChild () {return Child;}
00124         gcu::Object *GetStoichChild () {return Stoichiometry;}
00125 
00129         std::string Name ();
00130 
00131 private:
00132         unsigned m_Stoich;      //always positive
00133         gcu::Object *Stoichiometry;
00134         gcu::Object *Child;
00135 };
00136 
00137 }       //      namespace gcp
00138 
00139 #endif //       GCHEMPAINT_REACTANT_H

Generated on Fri Sep 24 15:58:42 2010 for The Gnome Chemistry Utils by  doxygen 1.5.9