reactant.h

Go to the documentation of this file.

// -*- C++ -*-

/*
 * GChemPaint library
 * reactant.h
 *
 * Copyright (C) 2004-2011 Jean Bréfort <jean.brefort@normalesup.org>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 3 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */

#ifndef GCHEMPAINT_REACTANT_H
#define GCHEMPAINT_REACTANT_H

#include <gcu/object.h>

namespace gcu {
class UIManager;
}

namespace gcp {

class ReactionStep;

class Reactant: public gcu::Object
{
public:
        Reactant ();
        virtual ~Reactant ();

        Reactant (ReactionStep* step, gcu::Object* object) throw (std::invalid_argument);

        virtual xmlNodePtr Save (xmlDocPtr xml) const;
        virtual bool Load (xmlNodePtr node);

        unsigned GetStoichiometry () const {return m_Stoich;}
        void SetStoichiometry (unsigned coef) {m_Stoich = coef;}
        virtual double GetYAlign ();
        bool BuildContextualMenu (gcu::UIManager *UIManager, gcu::Object *object, double x, double y);
        bool OnSignal (gcu::SignalId Signal, gcu::Object *Child);

        void AddStoichiometry ();
        gcu::Object *GetChild () {return Child;}
        gcu::Object *GetStoichChild () {return Stoichiometry;}

        std::string Name ();

private:
        unsigned m_Stoich;      //always positive
        gcu::Object *Stoichiometry;
        gcu::Object *Child;
};

}       //      namespace gcp

#endif //       GCHEMPAINT_REACTANT_H