The Gnome Chemistry Utils  0.14.0
Public Member Functions | List of all members
gcp::ReactionStep Class Reference

the list of reactants before or after a reaction arrow. More...

#include <gcp/reaction-step.h>

Inheritance diagram for gcp::ReactionStep:
gcp::MechanismStep gcp::Step gcu::Object

Public Member Functions

 ReactionStep ()
virtual ~ReactionStep ()
 ReactionStep (Reaction *reaction, std::map< double, gcu::Object * > &Children, std::map< gcu::Object *, gccv::Rect > Objects) throw (std::invalid_argument)
xmlNodePtr Save (xmlDocPtr xml) const
bool Load (xmlNodePtr node)
double GetYAlign ()
bool OnSignal (gcu::SignalId Signal, gcu::Object *Child)
std::string Name ()
void AddMolecule (Molecule *molecule, bool signal=true)
void OnLoaded ()
bool Validate ()
- Public Member Functions inherited from gcp::MechanismStep
 MechanismStep (gcu::TypeId type=MechanismStepType)
virtual ~MechanismStep ()
void NotifyEmpty ()
bool BuildContextualMenu (gcu::UIManager *UIManager, gcu::Object *object, double x, double y)
- Public Member Functions inherited from gcp::Step
 Step (gcu::TypeId type)
virtual ~Step ()
void AddArrow (Arrow *arrow, Step *step) throw (std::invalid_argument)
void RemoveArrow (Arrow *arrow, Step *step)
std::map< Step *, Arrow * > * GetArrows ()
- Public Member Functions inherited from gcu::Object
 Object (TypeId Id=OtherType)
virtual ~Object ()
TypeId GetType () const
void SetId (gchar const *Id)
char const * GetId () const
virtual void AddChild (Object *object)
ObjectGetMolecule () const
ObjectGetReaction () const
ObjectGetGroup () const
DocumentGetDocument () const
ApplicationGetApplication () 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 char *Id) const
ObjectGetParent () const
void SetParent (Object *Parent)
virtual bool GetCoords (double *x, double *y, double *z=NULL) const
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::set< Object * > const &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
void SetDirty (bool dirty=true)
virtual void Clear ()
std::string Identity ()
virtual char const * HasPropertiesDialog () const
virtual bool CanSelect () 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

the list of reactants before or after a reaction arrow.

The ReactionStep class is a group class which owns a list of reactants and the operators betwwen them. This class is misnamed, since the step is more generally associated with the arrow. It might be renamed ReactionStage in the future if it is possible without making old files unreadable.

Definition at line 49 of file reaction-step.h.

Constructor & Destructor Documentation

gcp::ReactionStep::ReactionStep ( )

The default constructor.

virtual gcp::ReactionStep::~ReactionStep ( )
virtual

The destructor.

gcp::ReactionStep::ReactionStep ( Reaction reaction,
std::map< double, gcu::Object * > &  Children,
std::map< gcu::Object *, gccv::Rect Objects 
) throw (std::invalid_argument)
Parameters
reactionthe parent reaction.
Childrenthe reactants from which to build the new instance.
Objectsthe rectangles bounding the reactants.

Buils a new reaction step from the children and adds as many eaction operators as necessary. All children will be horizontally aligned.

Member Function Documentation

void gcp::ReactionStep::AddMolecule ( Molecule molecule,
bool  signal = true 
)
Parameters
moleculea molecule.
signalwheter to emit the OnChangedSignal

Adds a molecule to this step.

double gcp::ReactionStep::GetYAlign ( )
virtual

Used to retrieve the y coordinate for alignment.

Returns
y coordinate used for the reaction step alignment.

Reimplemented from gcp::MechanismStep.

bool gcp::ReactionStep::Load ( xmlNodePtr  node)
virtual
Parameters
node,:a pointer to the xmlNode containing the serialized step.

Used to load a reaction step in memory.

Returns
true on succes, false otherwise.

Reimplemented from gcp::MechanismStep.

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

Reimplemented from gcp::MechanismStep.

void gcp::ReactionStep::OnLoaded ( )
virtual

This method should be called when an object has been fully loaded. The default method doesn't do anything.

Reimplemented from gcu::Object.

bool gcp::ReactionStep::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 reaction step, when one of its children changed. It should not be called by a program; call Object::EmitSignal instead.

Returns
true if the signal should be propagated to the parent, false otherwise.

Reimplemented from gcp::MechanismStep.

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

Used to save the reaction step to the xmlDoc.

Returns
the xmlNode containing the serialized step.

Reimplemented from gcp::MechanismStep.

bool gcp::ReactionStep::Validate ( )
Returns
true if there is at least one arrow associated with this step if the step is not empty of if there are non consecutive arrows around.

Reimplemented from gcp::Step.


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