The Gnome Chemistry Utils  0.12.11
reactant.h
Go to the documentation of this file.
1 // -*- C++ -*-
2 
3 /*
4  * GChemPaint library
5  * reactant.h
6  *
7  * Copyright (C) 2004-2010 Jean Bréfort <jean.brefort@normalesup.org>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License as
11  * published by the Free Software Foundation; either version 2 of the
12  * License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
22  * USA
23  */
24 
25 #ifndef GCHEMPAINT_REACTANT_H
26 #define GCHEMPAINT_REACTANT_H
27 
28 #include <gcu/object.h>
29 
31 namespace gcp {
32 
33 class ReactionStep;
34 
41 class Reactant: public gcu::Object
42 {
43 public:
47  Reactant ();
51  virtual ~Reactant ();
52 
57  Reactant (ReactionStep* step, gcu::Object* object) throw (std::invalid_argument);
58 
65  virtual xmlNodePtr Save (xmlDocPtr xml) const;
73  virtual bool Load (xmlNodePtr node);
74 
78  unsigned GetStoichiometry () const {return m_Stoich;}
84  void SetStoichiometry (unsigned coef) {m_Stoich = coef;}
89  virtual double GetYAlign ();
99  bool BuildContextualMenu (GtkUIManager *UIManager, gcu::Object *object, double x, double y);
110  bool OnSignal (gcu::SignalId Signal, gcu::Object *Child);
111 
116  void AddStoichiometry ();
120  gcu::Object *GetChild () {return Child;}
124  gcu::Object *GetStoichChild () {return Stoichiometry;}
125 
129  std::string Name ();
130 
131 private:
132  unsigned m_Stoich; //always positive
133  gcu::Object *Stoichiometry;
134  gcu::Object *Child;
135 };
136 
137 } // namespace gcp
138 
139 #endif // GCHEMPAINT_REACTANT_H