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

Classe definissant une molecule. Plus de détails...

#include <Molecule.h>

Diagramme de collaboration de API::Molecule:

[Légende]Liste de tous les membres

Membres publics
unsigned int	getID ()
	retourne l'identifiant de la molecule courante
unsigned int	getAtomCount () const
	retourne le nombre d'atomes de la molecule courante
Atom *	getAtom (unsigned int index) const
	retourne un atome de la molecule courante
int	getAtomIndex (Atom *anAtom) const
	retourne l'index d'un atome dans la molecule courante.
unsigned int	getLinkCount () const
	retourne le nombre de connexions de la molecule courante.
unsigned int	getLinkCount (unsigned int atomIndex1, unsigned int atomIndex2) const
	retourne le nombre de connexions entre deux atomes de la molecule courante.
Link *	getLink (unsigned int atomIndex1, unsigned int atomIndex2, unsigned linkIndex=0) const
	retourne la reference de la (premiere) connexion entre deux atomes de la molecule courante.
Link *	getLink (unsigned int index) const
	retourne une connexion de la molecule courante
int	getLinkIndex (Link *aLink) const
	retourne l'index d'une connexion dans la molecule courante.
void	atomize ()
	procede a la deconnexion de toutes les pattes de chaque atome de la molecule
void	stop ()
	procede a l'arret des mouvements de toutes les pattes de chaque atome de la molecule
unsigned int	getNextSyncIndex ()
	donne le prochain index de synchronisation de la molecule
unsigned int	getSyncIndexCount ()
	donne le nombre d'index de synchronisation utilise
unsigned int	getSyncIndex (unsigned int index)
	donne l'index de synchronisation actif
void	releaseSyncIndex (unsigned int index)
	libere l'index de synchronisation la molecule courante.
bool	isFinished (unsigned int index)
	renvoie si toutes les entites synchronisees selon l'index de synchronisation ont terminees leur traitement.
Attributs Publics
Util *	util
	Reference de l'instance de la classe specifique a la simulation d'une molecule.
Membres protégés
	Molecule ()
	constructeur d'une molecule
	~Molecule ()
	destructeur d'une molecule
void	setID (int aMoleculeID)
	affecte l'identifiant de la molecule courante
void	addAtom (Atom *atom)
	ajoute un atome a la molecule courante
void	removeAtom (Atom *atom)
	enleve un atome de la molecule courante
void	insertLink (Link *link)
	ajoute une connexion a la molecule courante
void	removeLink (Link *link)
	enleve une connexion de la molecule courante

---

Description détaillée

Classe definissant une molecule.

Auteur:

Michel Dubois, Yann Le Guyadec

Version:

du 25/05/03 (25 mai 2003)

Depuis:

0.1

---

Documentation des contructeurs et destructeurs

API::Molecule::Molecule (   )  [protected]

constructeur d'une molecule

API::Molecule::~Molecule (   )  [protected]

destructeur d'une molecule

---

Documentation des méthodes

void API::Molecule::addAtom (  Atom *  atom  )  [protected]

ajoute un atome a la molecule courante Paramètres: atom  reference de l'atome a ajouter

void API::Molecule::atomize (   )

procede a la deconnexion de toutes les pattes de chaque atome de la molecule Cette methode reduit la molecule a un seul atome. De plus il y a creation de getAtomCount()-1 molecules toutes reduites a un seul atome.

Atom* API::Molecule::getAtom (  unsigned int  index  )  const

retourne un atome de la molecule courante Paramètres: index  index de l'atome dans la molecule Renvoie: la reference de l'atome

unsigned int API::Molecule::getAtomCount (   )  const

retourne le nombre d'atomes de la molecule courante Renvoie: le nombre d'atomes

int API::Molecule::getAtomIndex (  Atom *  anAtom  )  const

retourne l'index d'un atome dans la molecule courante. retourne l'index (la position relative) d'un atome dans la molecule courante Paramètres: anAtom  la reference de l'atome Renvoie: la position relative de l'atome dans la molecule (0..getAtomCount()-1 ou -1 si l'atome n'appartient pas a la molecule

unsigned int API::Molecule::getID (   )

retourne l'identifiant de la molecule courante Renvoie: le numero de l'atome

Link* API::Molecule::getLink (  unsigned int  index  )  const

retourne une connexion de la molecule courante Paramètres: index  index de la connexion dans la molecule Renvoie: la reference de la connexion

Link* API::Molecule::getLink (  unsigned int  atomIndex1, unsigned int  atomIndex2, unsigned  linkIndex = 0 )  const

retourne la reference de la (premiere) connexion entre deux atomes de la molecule courante. Paramètres: atomIndex1  la position relative (=index) du premier atome atomIndex2  la position relative (=index) du deuxieme atome linkIndex  la position relative (=index) de la connexion Renvoie: la reference de la connexion

unsigned int API::Molecule::getLinkCount (  unsigned int  atomIndex1, unsigned int  atomIndex2 )  const

retourne le nombre de connexions entre deux atomes de la molecule courante. On compte le nombre de connexions entre deux atomes Paramètres: atomIndex1  la position relative (=index) du premier atome atomIndex2  la position relative (=index) du deuxieme atome Renvoie: le nombre de connexions (0 .. 3, 0 si atomIndex1==atomIndex2)

unsigned int API::Molecule::getLinkCount (   )  const

retourne le nombre de connexions de la molecule courante. On compte chaque paires de pattes connectees Renvoie: le nombre de connexions (0 ou plus)

int API::Molecule::getLinkIndex (  Link *  aLink  )  const

retourne l'index d'une connexion dans la molecule courante. retourne l'index (la position relative) d'une connexion dans la molecule courante Paramètres: aLink  la reference de la connexion Renvoie: la position relative de la connexion dans la molecule (0..getLinkCount()-1 ou -1 si la connexion n'appartient pas a la molecule

unsigned int API::Molecule::getNextSyncIndex (   )

donne le prochain index de synchronisation de la molecule Renvoie: l'index de synchronisation disponible

unsigned int API::Molecule::getSyncIndex (  unsigned int  index  )

donne l'index de synchronisation actif Paramètres: index  le rang dans la liste des index de synchronisation Renvoie: l'index de synchronisation actif

unsigned int API::Molecule::getSyncIndexCount (   )

donne le nombre d'index de synchronisation utilise Renvoie: le nombre d'index de synchronisation

void API::Molecule::insertLink (  Link *  link  )  [protected]

ajoute une connexion a la molecule courante Paramètres: link  reference de la connexion a ajouter

bool API::Molecule::isFinished (  unsigned int  index  )

renvoie si toutes les entites synchronisees selon l'index de synchronisation ont terminees leur traitement. Paramètres: index  l'index de synchronisation Renvoie: si les traitements sont termines

void API::Molecule::releaseSyncIndex (  unsigned int  index  )

libere l'index de synchronisation la molecule courante. lorsque l'on utilise plus l'ensemble de synchronisation, il faut liberer les ressources Paramètres: index  l'index de synchronisation

void API::Molecule::removeAtom (  Atom *  atom  )  [protected]

enleve un atome de la molecule courante Paramètres: atom  reference de l'atome a enlever

void API::Molecule::removeLink (  Link *  link  )  [protected]

enleve une connexion de la molecule courante Paramètres: link  reference de la connexion a enlever

void API::Molecule::setID (  int  aMoleculeID  )  [protected]

affecte l'identifiant de la molecule courante Paramètres: aMoleculeID  numero de la molecule

void API::Molecule::stop (   )

procede a l'arret des mouvements de toutes les pattes de chaque atome de la molecule

---

Documentation des fonctions amies et associées

friend class Atom [friend]

friend class Leg [friend]

friend class Util [friend]

---

Documentation des données imbriquées

Util* API::Molecule::util

Reference de l'instance de la classe specifique a la simulation d'une molecule.

---

La documentation associée à cette classe a été générée à partir du fichier suivant :

• Molecule.h

---