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

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

#include <Link.h>

Diagramme de collaboration de API::Link:

[Légende]Liste de tous les membres

Membres publics
Molecule *	getMolecule () const
	Retourne la reference de la molecule de la connexion courante.
Leg *	getLeg1 () const
	retourne l'instance de la patte numero 1 de la connexion
Leg *	getLeg2 () const
	retourne l'instance de la patte numero 2 de la connexion
bool	isUsing (Leg *aLeg) const
	retourne si une patte fait partie de la connexion
Leg *	getOtherLeg (Leg *aLeg) const
	retourne l'instance de l'autre patte de la connexion
void	swap ()
	intervertit les deux pattes de la connexion
Attributs Publics
Util *	util
	Reference de l'instance de la classe specifique a la simulation d'une connexion.
Membres protégés
	Link (Leg *aLeg, Leg *anotherLeg)
	constructeur d'une connexion
	~Link ()
	destructeur d'une connexion
void	setMolecule (Molecule *aMolecule)
	Affecte la connexion courante a une molecule.

---

Description détaillée

Classe definissant une connexion.

Une connexion est une paire de pattes connectees, chaque patte appartenant a deux atomes d'une meme molecule.

Auteur:

Michel Dubois, Yann Le Guyadec

Version:

du 27/05/03 (27 juin 2003)

Depuis:

0.1

---

Documentation des contructeurs et destructeurs

API::Link::Link (  Leg *  aLeg, Leg *  anotherLeg )  [protected]

constructeur d'une connexion Paramètres: aLeg  reference de la premiere patte anotherLeg  reference de la deuxieme patte

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

destructeur d'une connexion

---

Documentation des méthodes

Leg* API::Link::getLeg1 (   )  const

retourne l'instance de la patte numero 1 de la connexion Renvoie: la reference de la patte numero 1 de la connexion courante

Leg* API::Link::getLeg2 (   )  const

retourne l'instance de la patte numero 2 de la connexion Renvoie: la reference de la patte numero 2 de la connexion courante

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

Retourne la reference de la molecule de la connexion courante. Renvoie: La reference de l'instance de la molecule qui possede la connexion courante

Leg* API::Link::getOtherLeg (  Leg *  aLeg  )  const

retourne l'instance de l'autre patte de la connexion Paramètres: aLeg  reference de la patte Renvoie: la reference de l'autre patte de la connexion courante

bool API::Link::isUsing (  Leg *  aLeg  )  const

retourne si une patte fait partie de la connexion Paramètres: aLeg  reference de la patte Renvoie: l'appartenance d'une patte a la connexion

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

Affecte la connexion courante a une molecule. Paramètres: aMolecule  Reference de la molecule

void API::Link::swap (   )

intervertit les deux pattes de la connexion

---

Documentation des fonctions amies et associées

friend class Leg [friend]

friend class Util [friend]

---

Documentation des données imbriquées

Util* API::Link::util

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

---

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

• Link.h

---