#include <gcp/electron.h>
List of all members.
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 |
( |
| ) |
|
Member Function Documentation
void gcp::Electron::AddItem |
( |
| ) |
[virtual] |
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.
- 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] |
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: