The Gnome Chemistry Utils 0.13.3
reactant.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 /* 
00004  * GChemPaint library
00005  * reactant.h 
00006  *
00007  * Copyright (C) 2004-2011 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 
00032 namespace gcu {
00033 class UIManager;
00034 }
00035 
00036 namespace gcp {
00037 
00038 class ReactionStep;
00039 
00046 class Reactant: public gcu::Object
00047 {
00048 public:
00052         Reactant ();
00056         virtual ~Reactant ();
00057 
00062         Reactant (ReactionStep* step, gcu::Object* object) throw (std::invalid_argument);
00063 
00070         virtual xmlNodePtr Save (xmlDocPtr xml) const;
00078         virtual bool Load (xmlNodePtr node);
00079 
00083         unsigned GetStoichiometry () const {return m_Stoich;}
00089         void SetStoichiometry (unsigned coef) {m_Stoich = coef;}
00094         virtual double GetYAlign ();
00104         bool BuildContextualMenu (gcu::UIManager *UIManager, gcu::Object *object, double x, double y);
00115         bool OnSignal (gcu::SignalId Signal, gcu::Object *Child);
00116 
00121         void AddStoichiometry ();
00125         gcu::Object *GetChild () {return Child;}
00129         gcu::Object *GetStoichChild () {return Stoichiometry;}
00130 
00134         std::string Name ();
00135 
00136 private:
00137         unsigned m_Stoich;      //always positive
00138         gcu::Object *Stoichiometry;
00139         gcu::Object *Child;
00140 };
00141 
00142 }       //      namespace gcp
00143 
00144 #endif //       GCHEMPAINT_REACTANT_H