Page principale | Liste des namespaces | Hiérarchie des classes | Liste par ordre alphabétique | Liste des composants | Liste des fichiers | Composants | Déclarations

Référence de la classe API::Atom

Classe definissant un atome. Plus de détails...

#include <Atom.h>

Diagramme de collaboration de API::Atom:

Collaboration graph
[Légende]
Liste de tous les membres

Membres publics

 Atom ()
 Constructeur d'un atome.

 ~Atom ()
 Destructeur d'un atome.

unsigned int getID () const
 Retourne l'identifiant de l'atome courant.

unsigned int getLegCount () const
 Retourne le nombre de pattes de l'atome courant.

Leg * getLeg (unsigned int aLegID) const
 Retourne la patte associee au numero physique passe en parametre.

Leg * getMappedLeg (unsigned int aLegID) const
 Retourne la patte associee au numero logique passe en parametre.

Molecule * getMolecule () const
 Retourne la reference de la molecule de l'atome courant.

std::vector< unsigned int > getMap () const
 Renvoie un tableau (un vecteur) indiquant quelle patte logique correspond a quelle patte physique ex : si a la ligne 2 on a la valeur 3, la patte physique 2 correspond a la patte logique 3.

Accelerometer * getAccelerometer (unsigned int anAccelerometerID) const
 Retourne la reference de l'accelerometre donne en parametre de l'atome courant.

unsigned int getAccelerometerCount () const
 Retourne le nombre d'accelerometre de l'atome courant.

Clock * getClock () const
 Retourne la reference de l'horloge de l'atome courant.

Girometer * getGirometer (unsigned int aGirometerID) const
 Retourne la reference du girometre donne en parametre de l'atome courant.

unsigned int getGirometerCount () const
 Retourne le nombre de girometre de l'atome courant.

void setMap (unsigned int face1, unsigned int face2)
 Repositionne le mappage des pattes par rapport aux nouvelles 1ere et 2eme pattes passees en parametre.

void stop ()
 Procede a l'arret des mouvements de toutes les pattes de l'atome courant.

Atom * getNeighbor (unsigned int LegID) const
 Retourne l'atome connecte a la patte physique passee en parametre.

unsigned int getConnectedLegCount () const
 Retourne le nombre de pattes connectees de l'atome courant.

unsigned int getConnectedAtomCount () const
 Retourne le nombre d'atomes distincts connectes a l'atome courant.


Attributs Publics

Util * util
 Reference de l'instance de la classe specifique a la simulation d'un atome.


Membres protégés

void setID (unsigned int anAtomID)
 Affecte l'identifiant de l'atome courant.

void setMolecule (Molecule *aMolecule)
 Affecte l'atome courant a une molecule.

Description détaillée

Classe definissant un atome.

Auteur:
Michel Dubois, Yann Le Guyadec
Version:
du 25/05/03 (25 mai 2003)
Depuis:
0.1

Documentation des contructeurs et destructeurs

API::Atom::Atom (   ) 
 

Constructeur d'un atome.

API::Atom::~Atom (   ) 
 

Destructeur d'un atome.

Documentation des méthodes

Accelerometer* API::Atom::getAccelerometer (  unsigned int  anAccelerometerID  )  const
 

Retourne la reference de l'accelerometre donne en parametre de l'atome courant.

Paramètres:
anAccelerometerID Numero identifiant l'accelerometre
Renvoie:
La reference de l'une des instances d'accelerometre de l'atome courant

unsigned int API::Atom::getAccelerometerCount (   )  const
 

Retourne le nombre d'accelerometre de l'atome courant.

Renvoie:
Le nombre d'accelerometre de l'atome (normalement 3)

Clock* API::Atom::getClock (   )  const
 

Retourne la reference de l'horloge de l'atome courant.

Renvoie:
La reference de l'instance de l'horloge de l'atome courant

unsigned int API::Atom::getConnectedAtomCount (   )  const
 

Retourne le nombre d'atomes distincts connectes a l'atome courant.

Renvoie:
le nombre d'atomes reellement connectes a l'atome (de 0 a 6)

unsigned int API::Atom::getConnectedLegCount (   )  const
 

Retourne le nombre de pattes connectees de l'atome courant.

Renvoie:
Le nombre de pattes connectees de l'atome (au plus 6)

Girometer* API::Atom::getGirometer (  unsigned int  aGirometerID  )  const
 

Retourne la reference du girometre donne en parametre de l'atome courant.

Paramètres:
aGirometerID Numero identifiant le girometre
Renvoie:
La reference de l'une des instances de gyrometre de l'atome courant

unsigned int API::Atom::getGirometerCount (   )  const
 

Retourne le nombre de girometre de l'atome courant.

Renvoie:
Le nombre de gyrometre de l'atome (normalement 3)

unsigned int API::Atom::getID (   )  const
 

Retourne l'identifiant de l'atome courant.

Renvoie:
le numero de l'atome

Leg* API::Atom::getLeg (  unsigned int  aLegID  )  const
 

Retourne la patte associee au numero physique passe en parametre.

Paramètres:
aLegID Identifiant physique de la patte
Renvoie:
la patte associee au numero physique

unsigned int API::Atom::getLegCount (   )  const
 

Retourne le nombre de pattes de l'atome courant.

Renvoie:
Le nombre de pattes de l'atome (normalement 6)

std::vector<unsigned int> API::Atom::getMap (   )  const
 

Renvoie un tableau (un vecteur) indiquant quelle patte logique correspond a quelle patte physique ex : si a la ligne 2 on a la valeur 3, la patte physique 2 correspond a la patte logique 3.

Renvoie:
La correspondance patte physique/patte logique de l'atome courant

Leg* API::Atom::getMappedLeg (  unsigned int  aLegID  )  const
 

Retourne la patte associee au numero logique passe en parametre.

Paramètres:
aLegID Identifiant logique de la patte
Renvoie:
La patte associee au numero logique passee en parametre

Molecule* API::Atom::getMolecule (   )  const
 

Retourne la reference de la molecule de l'atome courant.

Renvoie:
La reference de l'instance de la molecule qui possede l'atome courant

Atom* API::Atom::getNeighbor (  unsigned int  LegID  )  const
 

Retourne l'atome connecte a la patte physique passee en parametre.

Paramètres:
LegID Identifiant physique de la patte
Renvoie:
L'atome connecte a la patte physique passee en parametre

void API::Atom::setID (  unsigned int  anAtomID  )  [protected]
 

Affecte l'identifiant de l'atome courant.

Paramètres:
anAtomID Numero de l'atome

void API::Atom::setMap (  unsigned int  face1,
unsigned int  face2
) 
 

Repositionne le mappage des pattes par rapport aux nouvelles 1ere et 2eme pattes passees en parametre.

Paramètres:
face1 Nouvelle patte numero 0 (logique )
face2 Nouvelle patte numero 1 (logique )

void API::Atom::setMolecule (  Molecule *  aMolecule  )  [protected]
 

Affecte l'atome courant a une molecule.

Paramètres:
aMolecule Reference de la molecule

void API::Atom::stop (   ) 
 

Procede a l'arret des mouvements de toutes les pattes de l'atome courant.

Documentation des fonctions amies et associées

friend class Molecule [friend]
 

friend class Util [friend]
 

Documentation des données imbriquées

Util* API::Atom::util
 

Reference de l'instance de la classe specifique a la simulation d'un atome.

La documentation associée à cette classe a été générée à partir du fichier suivant :
Généré le Mon Mar 1 01:31:09 2004 par doxygen 1.3.3