The Gnome Chemistry Utils 0.13.3
|
the list of reactants before or after a reaction arrow. More...
#include <gcp/reaction-step.h>
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) |
void | AddArrow (ReactionArrow *arrow) |
void | RemoveArrow (ReactionArrow *arrow) |
std::string | Name () |
void | AddMolecule (Molecule *molecule, bool signal=true) |
void | OnLoaded () |
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.
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) |
reaction | the parent reaction. |
Children | the reactants from which to build the new instance. |
Objects | the 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.
void gcp::ReactionStep::AddArrow | ( | ReactionArrow * | arrow | ) | [inline] |
arrow | an arrow related to this instance. |
Adds an arrow to the list of arrows related to this instance.
Definition at line 106 of file reaction-step.h.
void gcp::ReactionStep::AddMolecule | ( | Molecule * | molecule, |
bool | signal = true |
||
) |
molecule | a molecule. |
signal | wheter to emit the OnChangedSignal |
Adds amolecue to this step.
double gcp::ReactionStep::GetYAlign | ( | ) | [virtual] |
Used to retrieve the y coordinate for alignment.
Reimplemented from gcp::MechanismStep.
bool gcp::ReactionStep::Load | ( | xmlNodePtr | node | ) | [virtual] |
node,: | a pointer to the xmlNode containing the serialized step. |
Used to load a reaction step in memory.
Reimplemented from gcp::MechanismStep.
std::string gcp::ReactionStep::Name | ( | ) | [virtual] |
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] |
Signal | the appropriate SignalId |
Child | the 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.
Reimplemented from gcp::MechanismStep.
void gcp::ReactionStep::RemoveArrow | ( | ReactionArrow * | arrow | ) |
arrow | an arrow related to this instance. |
Removes an arrow from the list of arrows related to this instance when it not anymore relevant.
xmlNodePtr gcp::ReactionStep::Save | ( | xmlDocPtr | xml | ) | const [virtual] |
xml | the xmlDoc used to save the document. |
Used to save the reaction step to the xmlDoc.
Reimplemented from gcp::MechanismStep.