The Gnome Chemistry Utils  0.12.11
Public Member Functions
gcp::Reactant Class Reference

Class for reactants and products of a chemical reaction. More...

#include <gcp/reactant.h>

Inheritance diagram for gcp::Reactant:
gcu::Object

List of all members.

Public Member Functions

 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
void SetStoichiometry (unsigned coef)
virtual double GetYAlign ()
bool BuildContextualMenu (GtkUIManager *UIManager, gcu::Object *object, double x, double y)
bool OnSignal (gcu::SignalId Signal, gcu::Object *Child)
void AddStoichiometry ()
gcu::ObjectGetChild ()
gcu::ObjectGetStoichChild ()
std::string Name ()
- Public Member Functions inherited from gcu::Object
 Object (TypeId Id=OtherType)
virtual ~Object ()
TypeId GetType () const
void SetId (gchar const *Id)
gchar const * GetId () const
virtual void AddChild (Object *object)
ObjectGetMolecule () const
ObjectGetReaction () const
ObjectGetGroup () const
DocumentGetDocument () const
ObjectGetParentOfType (TypeId Id) const
ObjectGetChild (const gchar *Id) const
ObjectGetFirstChild (std::map< std::string, Object * >::iterator &i)
ObjectGetNextChild (std::map< std::string, Object * >::iterator &i)
ObjectGetDescendant (const gchar *Id) const
ObjectGetParent () const
void SetParent (Object *Parent)
virtual void Move (double x, double y, double z=0.)
virtual void Transform2D (Matrix2D &m, double x, double y)
bool SaveChildren (xmlDocPtr xml, xmlNodePtr node) const
void SaveId (xmlNodePtr node) const
xmlNodePtr GetNodeByProp (xmlNodePtr node, char const *Property, char const *Id)
xmlNodePtr GetNextNodeByProp (xmlNodePtr node, char const *Property, char const *Id)
xmlNodePtr GetNodeByName (xmlNodePtr node, char const *Name)
xmlNodePtr GetNextNodeByName (xmlNodePtr node, char const *Name)
bool HasChildren () const
unsigned GetChildrenNumber () const
virtual ObjectGetAtomAt (double x, double y, double z=0.)
virtual bool Build (std::list< Object * > &Children) throw (std::invalid_argument)
void EmitSignal (SignalId Signal)
void Lock (bool state=true)
bool IsLocked ()
ObjectGetFirstLink (std::set< Object * >::iterator &i)
ObjectGetNextLink (std::set< Object * >::iterator &i)
void Link (Object *object)
void Unlink (Object *object)
virtual void OnUnlink (Object *object)
void GetPossibleAncestorTypes (std::set< TypeId > &types) const
virtual bool SetProperty (unsigned property, char const *value)
virtual std::string GetProperty (unsigned property) const
virtual void OnLoaded ()
void SetDirty (bool dirty=true)
virtual void Clear ()
std::string Identity ()
virtual char const * HasPropertiesDialog () const
void ShowPropertiesDialog ()
bool GetDirty (void) const

Additional Inherited Members

- Static Public Member Functions inherited from gcu::Object
static TypeId AddType (std::string TypeName, Object *(*CreateFunc)(), TypeId id=OtherType)
static void AddAlias (TypeId id, std::string TypeName)
static ObjectCreateObject (const std::string &TypeName, Object *parent=NULL)
static TypeId GetTypeId (const std::string &Name)
static std::string GetTypeName (TypeId Id)
static void AddMenuCallback (TypeId Id, BuildMenuCb cb)
static void AddRule (TypeId type1, RuleId rule, TypeId type2)
static void AddRule (const std::string &type1, RuleId rule, const std::string &type2)
static const std::set< TypeId > & GetRules (TypeId type, RuleId rule)
static const std::set< TypeId > & GetRules (const std::string &type, RuleId rule)
static void SetCreationLabel (TypeId Id, std::string Label)
static const std::string & GetCreationLabel (TypeId Id)
static const std::string & GetCreationLabel (const std::string &TypeName)
static SignalId CreateNewSignalId ()
- Protected Member Functions inherited from gcu::Object
virtual DialogBuildPropertiesDialog ()

Detailed Description

Class for reactants and products of a chemical reaction.

Objects of these class embed either a molecule or a text representing a reactant or a product for a chemical reaction. They can have a stoichiometry coefficient.

Definition at line 41 of file reactant.h.


Constructor & Destructor Documentation

gcp::Reactant::Reactant ( )

The default constructor.

virtual gcp::Reactant::~Reactant ( )
virtual

The destructor.

gcp::Reactant::Reactant ( ReactionStep step,
gcu::Object object 
) throw (std::invalid_argument)
Parameters:
stepthe parent reaction step.
objectthe molecule formula or text to use as reactant.

Member Function Documentation

void gcp::Reactant::AddStoichiometry ( )

Adds a text item to display the reactants stoichiometry coefficient. This coefficient does not need to be an integer, but should always be positive.

bool gcp::Reactant::BuildContextualMenu ( GtkUIManager *  UIManager,
gcu::Object object,
double  x,
double  y 
)
virtual
Parameters:
UIManagerthe GtkUIManager to populate.
objectthe Object on which occured the mouse click.
xx coordinate of the mouse click.
yy coordinate of the mouse click.

This method is called to build a contextual menu for the reactant.

Returns:
true if something is added to the UIManager, false otherwise.

Reimplemented from gcu::Object.

gcu::Object* gcp::Reactant::GetChild ( )
inline
Returns:
the molecule or text embedded in this instance.

Definition at line 120 of file reactant.h.

gcu::Object* gcp::Reactant::GetStoichChild ( )
inline
Returns:
the text representing the stoichiometry coefficient of this instance.

Definition at line 124 of file reactant.h.

unsigned gcp::Reactant::GetStoichiometry ( ) const
inline
Returns:
the reactants stoichiometry coefficient.

Definition at line 78 of file reactant.h.

virtual double gcp::Reactant::GetYAlign ( )
virtual

Used to retrieve the y coordinate for alignment.

Returns:
y coordinate used for reactant alignment.

Reimplemented from gcu::Object.

virtual bool gcp::Reactant::Load ( xmlNodePtr  node)
virtual
Parameters:
nodea pointer to the xmlNode containing the serialized reactant.

Used to load a reactant in memory. The Reactant instance must already exist.

Returns:
true on succes, false otherwise.

Reimplemented from gcu::Object.

std::string gcp::Reactant::Name ( )
virtual
Returns:
the localized object generic name.

Reimplemented from gcu::Object.

bool gcp::Reactant::OnSignal ( gcu::SignalId  Signal,
gcu::Object Child 
)
virtual
Parameters:
Signalthe appropriate SignalId
Childthe child which emitted the signal or NULL

This function is called by the framework when a signal has been emitted for the reactant, when the embedded text or molecule changed. It should not be called by a program; call Object::EmitSignal instead.

Returns:
true to propagate the signal to the parent.

Reimplemented from gcu::Object.

virtual xmlNodePtr gcp::Reactant::Save ( xmlDocPtr  xml) const
virtual
Parameters:
xmlthe xmlDoc used to save the document.

Used to save the reactant to the xmlDoc.

Returns:
the xmlNode containing the serialized reactant.

Reimplemented from gcu::Object.

void gcp::Reactant::SetStoichiometry ( unsigned  coef)
inline
Parameters:
coefthe new stoichiometry coefficient.

Sets the stoichiometry coefficient for the reactant.

Definition at line 84 of file reactant.h.


The documentation for this class was generated from the following file: