gcp::Electron Class Reference

#include <gcp/electron.h>

Inheritance diagram for gcp::Electron:

Public Member Functions
	Electron (Atom *pAtom, bool IsPair)
	~Electron ()
bool	IsPair ()
char	GetPosition (double *angle, double *distance)
void	SetPosition (unsigned char Pos, double angle=0., double distance=0.)
void	AddItem ()
void	SetSelected (int state)
xmlNodePtr	Save (xmlDocPtr xml) const
bool	Load (xmlNodePtr node)
bool	OnSignal (gcu::SignalId Signal, gcu::Object *Child)
void	Transform2D (gcu::Matrix2D &m, double x, double y)
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 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)
virtual double	GetYAlign ()
virtual bool	BuildContextualMenu (UIManager *uim, Object *object, double x, double y)
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
Public Member Functions inherited from gccv::ItemClient
	ItemClient ()
virtual	~ItemClient ()
virtual void	UpdateItem ()
Item *	GetItem (void)

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 ()
Protected Attributes inherited from gccv::ItemClient
Item *	m_Item

Detailed Description

Represents either single elecgtrons or electrons pairs.

Definition at line 44 of file electron.h.

Constructor & Destructor Documentation

gcp::Electron::Electron	(	Atom *	pAtom,
		bool	IsPair
	)

Parameters

pAtom	the Atom to which the electrons belong.
IsPair	true for an electron pair and false for a single electron.

Constructs a new electron representation.

gcp::Electron::~Electron

(

)

The destructor

Member Function Documentation

void gcp::Electron::AddItem ( )

virtual

Used to add a representation of the Electron in the view.

Reimplemented from gccv::ItemClient.

char gcp::Electron::GetPosition	(	double *	angle,
		double *	distance
	)

Parameters

angle	where to store the angle from east direction in the trigonometric convention.
distance	where to store the distance from the center of the atom.

Returns

the electron position relative to its parent atom as one of POSITION_E, POSITION_N,...

bool gcp::Electron::IsPair ( )

inline

Returns

true for an electron pair and false for a single electron.

Definition at line 62 of file electron.h.

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

virtual

Parameters

node	a pointer to the xmlNode containing the serialized object.

Used to load an Electron in memory. The Electron must already exist.

Returns

true on succes, false otherwise.

Reimplemented from gcu::Object.

std::string gcp::Electron::Name ( )

virtual

Returns

the localized object generic name.

Reimplemented from gcu::Object.

bool gcp::Electron::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 when a signal has been emitted for the object. Elecgtron don't have children, so that Child will be ignored. Only the gcp::OnDeleteSignal is significant for this class. It should not be called by a program; call Object::EmitSignal instead.

Returns

true if the signal should be propagated to the parent, false otherwise.

Reimplemented from gcu::Object.

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

virtual

Parameters

xml	the xmlDoc used to save the document.

Used to save the Electron to the xmlDoc.

Returns

the xmlNode containing the serialized Electron.

Reimplemented from gcu::Object.

void gcp::Electron::SetPosition	(	unsigned char	Pos,
		double	angle = 0.,
		double	distance = 0.
	)

Parameters

Pos	one of POSITION_E, POSITION_N,...
angle	the angle from the east direction in the trigonometric convention.
distance	the distance from the center of the atom, or 0. if automatic.

Sets the position of an electron relative to its parent atom.

void gcp::Electron::SetSelected ( int  state )

virtual

Parameters

state

the selection state of the Electron.

Used to set the selection state of the Electron inside the widget. The values of state might be gcp::SelStateUnselected, gcp::SelStateSelected, gcp::SelStateUpdating, or gcp::SelStateErasing.

Reimplemented from gccv::ItemClient.

void gcp::Electron::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.

Used to move and/or transform an Electron.

Reimplemented from gcu::Object.

---

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

• electron.h