Mechanism step. More...

#include <mechanism-step.h>

Inheritance diagram for gcp::MechanismStep:

Public Member Functions
	MechanismStep (gcu::TypeId type=MechanismStepType)
virtual	~MechanismStep ()
double	GetYAlign ()
bool	OnSignal (gcu::SignalId Signal, gcu::Object *Child)
xmlNodePtr	Save (xmlDocPtr xml) const
bool	Load (xmlNodePtr node)
std::string	Name ()
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)
bool	Validate ()
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)
Object *	GetMolecule () const
Object *	GetReaction () const
Object *	GetGroup () const
Document *	GetDocument () const
Application *	GetApplication () const
Object *	GetParentOfType (TypeId Id) const
Object *	GetChild (const gchar *Id) const
Object *	GetFirstChild (std::map< std::string, Object * >::iterator &i)
Object *	GetNextChild (std::map< std::string, Object * >::iterator &i)
Object *	GetDescendant (const char *Id) const
Object *	GetParent () 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 Object *	GetAtomAt (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 ()
Object *	GetFirstLink (std::set< Object * >::iterator &i)
Object *	GetNextLink (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
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 Object *	CreateObject (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 Dialog *	BuildPropertiesDialog ()

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

bool gcp::MechanismStep::BuildContextualMenu	(	gcu::UIManager *	UIManager,
		gcu::Object *	object,
		double	x,
		double	y
	)

virtual

Parameters

UIManager	the gcu::UIManager to populate.
object	the Object on which occured the mouse click.
x	x coordinate of the mouse click.
y	y coordinate of the mouse click.

This method is called to build the contextual menu for the mechanism step.

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

Reimplemented from gcu::Object.

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::ReactionStep, and gcp::Mesomer.

std::string gcp::MechanismStep::Name ( )

virtual

Returns: the localized object generic name.

Reimplemented from gcu::Object.

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

void gcp::MechanismStep::NotifyEmpty ( )

virtual

Destroys the MechanismStep when empty.

Reimplemented from gcu::Object.

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::ReactionStep, and gcp::Mesomer.

xmlNodePtr gcp::MechanismStep::Save ( xmlDocPtr xml ) const

virtual

Parameters

xml	the xmlDoc used to save the document.

Used to save the reaction step to the xmlDoc.

Returns: the xmlNode containing the serialized step.

Reimplemented from gcu::Object.

Reimplemented in gcp::ReactionStep.

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

mechanism-step.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation