gcp::MechanismStep Class Reference

Mechanism step. More...

#include <mechanism-step.h>

Inheritance diagram for gcp::MechanismStep:

gcu::Object gcp::Mesomer gcp::ReactionStep

List of all members.

Public Member Functions

 MechanismStep (gcu::TypeId type=MechanismStepType)
virtual ~MechanismStep ()
double GetYAlign ()
bool OnSignal (gcu::SignalId Signal, gcu::Object *Child)
bool Load (xmlNodePtr node)
std::string Name ()


Detailed Description

Mechanism step.

One or several molecules with mechanism arrows joining them.

Definition at line 41 of file mechanism-step.h.


Constructor & Destructor Documentation

gcp::MechanismStep::MechanismStep ( gcu::TypeId  type = MechanismStepType  ) 

Constructs a new MechanismStep.

virtual gcp::MechanismStep::~MechanismStep (  )  [virtual]

The destructor.


Member Function Documentation

double gcp::MechanismStep::GetYAlign (  )  [virtual]

Returns:
the alignment ordinate of the MechanismStep. Uses the average of the values returned by the molecules.

Reimplemented from gcu::Object.

Reimplemented in gcp::Mesomer, and gcp::ReactionStep.

bool gcp::MechanismStep::Load ( xmlNodePtr  node  )  [virtual]

Parameters:
node a pointer to the xmlNode containing the serialized step.
Used to load a mechanism step in memory. The MechanismStep must already exist.
Returns:
true on succes, false otherwise.

Reimplemented from gcu::Object.

Reimplemented in gcp::Mesomer, and gcp::ReactionStep.

std::string gcp::MechanismStep::Name (  )  [virtual]

Returns:
the localized object generic name.

Reimplemented from gcu::Object.

Reimplemented in gcp::Mesomer, and gcp::ReactionStep.

bool gcp::MechanismStep::OnSignal ( gcu::SignalId  Signal,
gcu::Object Child 
) [virtual]

Parameters:
Signal the appropriate SignalId
Child the child which emitted the signal or NULL
This function is called by the framework one of the molecules or arrows has changed. Might destroy the MechanismStep if there is not anymore an arrow.

Returns:
true to propagate the signal to the parent.

Reimplemented from gcu::Object.

Reimplemented in gcp::Mesomer, and gcp::ReactionStep.


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

Generated on Fri Sep 24 15:58:44 2010 for The Gnome Chemistry Utils by  doxygen 1.5.9