gcp::Mesomery Class Reference

#include <gcp/mesomery.h>

Inheritance diagram for gcp::Mesomery:

Public Member Functions
	Mesomery ()
bool	Load (xmlNodePtr node)
bool	Build (std::set< Object * > const &Children) throw (std::invalid_argument)
void	Transform2D (gcu::Matrix2D &m, double x, double y)
bool	BuildContextualMenu (gcu::UIManager *UIManager, gcu::Object *object, double x, double y)
bool	OnSignal (gcu::SignalId Signal, gcu::Object *Child)
bool	Validate (bool split)
void	Align ()
double	GetYAlign ()
std::string	Name ()
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 xmlNodePtr	Save (xmlDocPtr xml) const
virtual bool	GetCoords (double *x, double *y, double *z=NULL) const
virtual void	Move (double x, double y, double z=0.)
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
virtual void	NotifyEmpty ()
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

Represents mesomery relationships.

Definition at line 41 of file mesomery.h.

Constructor & Destructor Documentation

gcp::Mesomery::Mesomery

(

)

The default constructor. Builds a new empty mesomery relationship.

Member Function Documentation

void gcp::Mesomery::Align

(

)

Aligns the children.

bool gcp::Mesomery::Build

(

std::set< Object * > const &

Children

)

throw (std::invalid_argument)

Parameters

Children

the molecules and arrow involved in the mesomery.

Tries to associate mesomers and arrows so that the relationship is clearly established and aligns the objects. On failure, it throws an std::invalid_argument exception.

Returns

true on success.

bool gcp::Mesomery::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.

Builds the contextual menu for the mesomery.

Returns

true (failure would be a bug).

Reimplemented from gcu::Object.

double gcp::Mesomery::GetYAlign ( )

virtual

Returns

the alignment ordinate of the top mesomer.

Reimplemented from gcu::Object.

bool gcp::Mesomery::Load ( xmlNodePtr  node )

virtual

Parameters

node,:

a pointer to the xmlNode containing the serialized arrow.

Used to load an arrow in memory.

Returns

true on succes, false otherwise.

Reimplemented from gcu::Object.

std::string gcp::Mesomery::Name ( )

virtual

Returns

the localized object generic name.

Reimplemented from gcu::Object.

bool gcp::Mesomery::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. Realigns if the mesomery is still valid or destroys it.

Returns

true to propagate the signal to the parent.

Reimplemented from gcu::Object.

void gcp::Mesomery::Transform2D ( gcu::Matrix2D &  m, double  x, double  y  )

virtual

Parameters

m	the Matrix2D of the transformation.
x	the x component of the center of the transformation.
y	the y component of the center of the transformation.

Mesomeries can't be currently rotated. This method don't do anything. It is just there to inhibit the default behavior.

Reimplemented from gcu::Object.

bool gcp::Mesomery::Validate

(

bool

split

)

Parameters

split

whether to split the mesomery when arrows are missing.

Checks the validity of the mesomery, at least that each arrow is associated with two mesomers and all mesomers are related by arrows. Currently it does not check that the molecules are really mesomeric, but this might be implemented in the future.

Returns

true if the mesomery is valid or could be splitted, false otherwise.

---

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

• mesomery.h