gcp::MesomeryArrow Class Reference

#include <gcp/mesomery-arrow.h>

Inheritance diagram for gcp::MesomeryArrow:

gcp::Arrow gcu::Object gccv::ItemClient

List of all members.

Public Member Functions

 MesomeryArrow (Mesomery *mesomery)
virtual ~MesomeryArrow ()
xmlNodePtr Save (xmlDocPtr xml) const
bool Load (xmlNodePtr node)
void AddItem ()
void UpdateItem ()
void SetStartMesomer (Mesomer *mesomer)
MesomerGetStartMesomer ()
void SetEndMesomer (Mesomer *mesomer)
MesomerGetEndMesomer ()
void Reverse ()
std::string Name ()


Detailed Description

Arrow class for double headed arrows used in mesomery relationships.

Definition at line 38 of file mesomery-arrow.h.


Constructor & Destructor Documentation

gcp::MesomeryArrow::MesomeryArrow ( Mesomery mesomery  ) 

Parameters:
mesomery the parent mesomery relationship if any.
Constructs a mesomery arrow. If mesomery is not NULL, the arrow becomes is added to its children list.

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

The destructor.


Member Function Documentation

void gcp::MesomeryArrow::AddItem (  )  [virtual]

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

Reimplemented from gccv::ItemClient.

Mesomer* gcp::MesomeryArrow::GetEndMesomer (  )  [inline]

Returns:
the mesomer at last end of the arrow.

Definition at line 96 of file mesomery-arrow.h.

Mesomer* gcp::MesomeryArrow::GetStartMesomer (  )  [inline]

Returns:
the mesomer at first end of the arrow.

Definition at line 85 of file mesomery-arrow.h.

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

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

Returns:
the localized object generic name.

Reimplemented from gcp::Arrow.

void gcp::MesomeryArrow::Reverse (  ) 

Exchange both ends or the arrow and their associated mesomers.

xmlNodePtr gcp::MesomeryArrow::Save ( xmlDocPtr  xml  )  const [virtual]

Parameters:
xml the xmlDoc used to save the document.
Used to save the arrow to the xmlDoc.
Returns:
the xmlNode containing the serialized arrow.

Reimplemented from gcu::Object.

void gcp::MesomeryArrow::SetEndMesomer ( Mesomer mesomer  )  [inline]

Parameters:
mesomer a mesomer
Sets mesomer at last end of the arrow. This does not affect coordinates, alignment is dealt with elsewhere.

Definition at line 92 of file mesomery-arrow.h.

void gcp::MesomeryArrow::SetStartMesomer ( Mesomer mesomer  )  [inline]

Parameters:
mesomer a mesomer
Sets mesomer at first end of the arrow. This does not affect coordinates, alignment is dealt with elsewhere.

Definition at line 81 of file mesomery-arrow.h.

void gcp::MesomeryArrow::UpdateItem (  )  [virtual]

Used to update the representation of the arrow in the view.

Reimplemented from gccv::ItemClient.


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