gcp::Step Class Reference

parent class for reaction steps, mesomers, and more. More...

#include <gcp/step.h>

Inheritance diagram for gcp::Step:

Public Member Functions
	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 xmlNodePtr	Save (xmlDocPtr xml) const
virtual bool	Load (xmlNodePtr node)
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)
virtual double	GetYAlign ()
virtual bool	BuildContextualMenu (UIManager *uim, Object *object, double x, double y)
void	EmitSignal (SignalId Signal)
virtual bool	OnSignal (SignalId Signal, Object *Child)
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 ()
virtual std::string	Name ()
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

parent class for reaction steps, mesomers, and more.

Definition at line 39 of file step.h.

Constructor & Destructor Documentation

gcp::Step::Step

(

gcu::TypeId

type

)

The default constructor.

virtual gcp::Step::~Step ( )

virtual

The destructor.

Member Function Documentation

void gcp::Step::AddArrow	(	Arrow *	arrow,
		Step *	step
	)		throw (std::invalid_argument)

Parameters

arrow	an arrow
step	the Step at the other end of the arrow.

Adds the arrow to the arrows map. See Step::GetArrows().

std::map< Step *, Arrow * >* gcp::Step::GetArrows ( )

inline

Returns

the map of all arrows pointing to this Step indexed by the Step at the other end of the arrow.

Reimplemented in gcp::Mesomer.

Definition at line 74 of file step.h.

void gcp::Step::RemoveArrow	(	Arrow *	arrow,
		Step *	step
	)

Parameters

arrow	an arrow
step	the Step at the other end of the arrow.

Removes the arrow from the arrows map. See Step::GetArrows().

bool gcp::Step::Validate ( )

inline

Returns

true if the step is associated with at least one arrow, false otherwise. See gcp::Scheme::Validate() for more information.

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

Definition at line 69 of file step.h.

---

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

• step.h