#include <gcu/bond.h>
Public Member Functions | |
| Bond () | |
| Bond (Atom *first, Atom *last, unsigned char order) | |
| virtual | ~Bond () |
| virtual Atom * | GetAtom (int which) const |
| virtual Atom * | GetAtom (Atom *pAtom, int which=0) const |
| unsigned char | GetOrder () const |
| void | SetOrder (unsigned char Order) |
| virtual xmlNodePtr | Save (xmlDocPtr xml) const |
| virtual bool | Load (xmlNodePtr node) |
| virtual void | IncOrder (int n=1) |
| virtual bool | LoadNode (xmlNodePtr node) |
| virtual bool | SaveNode (xmlDocPtr xml, xmlNodePtr node) const |
| virtual void | Move (double x, double y, double z=0.) |
| virtual void | Transform2D (Matrix2D &m, double x, double y) |
| bool | SetProperty (unsigned property, char const *value) |
| std::string | GetProperty (unsigned property) const |
| virtual void | AddCycle (Cycle *pCycle) |
| virtual void | RemoveCycle (Cycle *pCycle) |
| virtual void | RemoveAllCycles () |
| unsigned | IsCyclic () |
| Cycle * | GetFirstCycle (std::list< Cycle * >::iterator &i, Cycle *pCycle) |
| Cycle * | GetNextCycle (std::list< Cycle * >::iterator &i, Cycle *pCycle) |
| bool | IsInCycle (Cycle *pCycle) |
| double | Get2DLength () |
| double | GetAngle2DRad (Atom *pAtom) |
| bool | ReplaceAtom (Atom *oldAtom, Atom *newAtom) |
| void | OnLoaded () |
| std::string | Name () |
Protected Attributes | |
| unsigned char | m_order |
| Atom * | m_Begin |
| Atom * | m_End |
| std::list< Cycle * > | m_Cycles |
This class is used to represent bonds.
Definition at line 42 of file gcu/bond.h.
| gcu::Bond::Bond | ( | ) |
The default constructor. Creates a bond with order set to 0.
Reimplemented in gcp::Bond.
| first | a pointer to the first Atom instance of the bond. | |
| last | a pointer to the last Atom instance of the bond. | |
| order | the order of the new bond. |
The distinction between first and last is important mostly for stereobonds. The Bond instance is created and adds itself to the two atoms calling Atom::AddBond.
| virtual void gcu::Bond::AddCycle | ( | Cycle * | pCycle | ) | [virtual] |
| pCycle | a cycle to add to the list. |
Reimplemented in gcp::Bond.
| double gcu::Bond::Get2DLength | ( | ) |
| double gcu::Bond::GetAngle2DRad | ( | Atom * | pAtom | ) |
| pAtom | one of the atoms of the bond. |
| pAtom | a pointer to an Atom instance. | |
| which | an index which might be used for multicentered bonds (not supported); the default value should always be used even if the implementation does not use it in this version. |
| virtual Atom* gcu::Bond::GetAtom | ( | int | which | ) | const [virtual] |
| i | a C++ std::map iterator. | |
| pCycle | a cycle. |
| i | a C++ std::map iterator initialized by Bond::GetFirstCycle. | |
| pCycle | a cycle. |
| unsigned char gcu::Bond::GetOrder | ( | ) | const |
| std::string gcu::Bond::GetProperty | ( | unsigned | property | ) | const [virtual] |
| property | the identity of the property as defined in objprops.h. |
Used by the gcu::Loader mechanism to retrieve properties of bonds.
Reimplemented from gcu::Object.
Reimplemented in gcp::Bond.
| virtual void gcu::Bond::IncOrder | ( | int | n = 1 |
) | [virtual] |
| n | the increment to add to the bond order |
If the resulting bond order is greater than 4, the remainder of the division by 4 is retained.
Reimplemented in gcp::Bond.
| unsigned gcu::Bond::IsCyclic | ( | ) | [inline] |
Definition at line 171 of file gcu/bond.h.
References m_Cycles.
| bool gcu::Bond::IsInCycle | ( | Cycle * | pCycle | ) |
| pCycle | a cycle in which the bond might be. |
| virtual bool gcu::Bond::Load | ( | xmlNodePtr | node | ) | [virtual] |
| node | a pointer to the xmlNode containing the serialized Bond. |
Loads a bond from an xmlNode.
Reimplemented from gcu::Object.
Reimplemented in gcu::CrystalBond.
| virtual bool gcu::Bond::LoadNode | ( | xmlNodePtr | node | ) | [virtual] |
| node | a pointer to the xmlNode containing the serialized Bond. |
This virtual method is called at the end of the Bond::Load method. The default behavior is to do nothing. It might be overrided for derived class when it is not convenient to override the Bond::Load method.
Reimplemented in gcp::Bond.
| virtual void gcu::Bond::Move | ( | double | x, | |
| double | y, | |||
| double | z = 0. | |||
| ) | [virtual] |
| x | the x component of the transation vector. | |
| y | the y component of the transation vector. | |
| z | the z component of the transation vector. |
Does nothing. Just a slight optimization to avoid execution of Object::Move
Reimplemented from gcu::Object.
Reimplemented in gcu::CrystalBond, and gcp::Bond.
| std::string gcu::Bond::Name | ( | ) | [virtual] |
Reimplemented from gcu::Object.
| void gcu::Bond::OnLoaded | ( | ) | [virtual] |
This method should be called when a bond has been fully loaded.
Reimplemented from gcu::Object.
| virtual void gcu::Bond::RemoveAllCycles | ( | ) | [virtual] |
Clears the bond cycles list.
Reimplemented in gcp::Bond.
| virtual void gcu::Bond::RemoveCycle | ( | Cycle * | pCycle | ) | [virtual] |
| pCycle | a cycle to remove from the list. |
Reimplemented in gcp::Bond.
| oldAtom | the atom to replace. | |
| newAtom | the new atom. |
To sucess, this needs that the new atom can accept all the bonds from the old one.
| virtual xmlNodePtr gcu::Bond::Save | ( | xmlDocPtr | xml | ) | const [virtual] |
| xml | the xmlDoc used to save the document. |
Reimplemented from gcu::Object.
| virtual bool gcu::Bond::SaveNode | ( | xmlDocPtr | xml, | |
| xmlNodePtr | node | |||
| ) | const [virtual] |
| xml | the xmlDoc used to save the document. | |
| node | a pointer to the xmlNode to which this Bond is serialized. |
This virtual method is called at the end of the Bond::Save method. The default behavior is to do nothing. It might be overrided for derived class when it is not convenient to override the Bond::Save method.
Reimplemented in gcp::Bond.
| void gcu::Bond::SetOrder | ( | unsigned char | Order | ) |
| Order | the new bond order. |
The value used is not checked. Should be a significant value (1 to 3, exceptionally 4).
| bool gcu::Bond::SetProperty | ( | unsigned | property, | |
| char const * | value | |||
| ) | [virtual] |
| property | the identity of the property as defined in objprops.h. | |
| value | the value of the property as a string. |
Used by the gcu::Loader mechanism to load properties of bonds.
Reimplemented from gcu::Object.
Reimplemented in gcp::Bond.
| virtual void gcu::Bond::Transform2D | ( | Matrix2D & | m, | |
| double | x, | |||
| double | y | |||
| ) | [virtual] |
| m | the 2D Matrix of the transformation. | |
| x | the x component of the center of the transformation. | |
| y | the y component of the center of the transformation. |
Does nothing. Just a slight optimization to avoid execution of Object::Transform2D
Reimplemented from gcu::Object.
Reimplemented in gcp::Bond.
Atom* gcu::Bond::m_Begin [protected] |
A pointer to the first Atom instance of the Bond.
Definition at line 234 of file gcu/bond.h.
std::list<Cycle*> gcu::Bond::m_Cycles [protected] |
The gcu::Cycle instnces to which the bond pertains.
Definition at line 243 of file gcu/bond.h.
Referenced by IsCyclic().
Atom* gcu::Bond::m_End [protected] |
A pointer to the last Atom instance of the Bond.
Definition at line 238 of file gcu/bond.h.
unsigned char gcu::Bond::m_order [protected] |
The order of the bond.
Definition at line 230 of file gcu/bond.h.
1.6.3