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::Leg

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

#include <Leg.h>

Diagramme de collaboration de API::Leg:

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

Membres publics

int getID () const
 Retourne l'identifiant de la patte courante.

int getMappedID () const
 Retourne le numero logique de la patte courante.

Atom * getAtom () const
 Retourne la reference de l'atome de la patte courante.

SphericPosition & getSphericPosition () const
 Retourne la position spherique de la patte courante.

CartesianPosition & getRelCartesianPosition () const
 Retourne la position cartesienne de l'extremite de la patte courante par rapport au centre de l'atome.

Leg * getLinkedLeg ()
 Retourne la reference de la patte liee a la patte courante.

Link * getLink () const
 Retourne la reference de la connexion a laquelle participe la patte courante.

std::string getMessage ()
 Retourne le premier message disponible de la patte courante.

ServoMotor * getServoMotor (unsigned int aServoMotorID) const
 Retourne la reference du servomoteur donne en parametre de la patte courante.

ForceSensor * getForceSensor (unsigned int aForceSensorID) const
 Retourne la reference du capteur d'efforts donne en parametre de la patte courante.

TouchSensor * getTouchSensor () const
 Retourne la reference du capteur de contact de la patte courante.

IRReceiver * getIRReceiver () const
 Retourne la reference du recepteur IR de la patte courante.

IRSender * getIRSender () const
 Retourne la reference de l'emetteur IR de la patte courante.

bool isLinked () const
 Retourne si la patte est connectee.

void setLink (Leg *aLeg)
 Prise en compte d'une connexion passive d'une patte passee en parametre avec la patte courante.

void sendMessage (std::string aMessage)
 Envoi d'un message passe en parametre a la patte connectee a la patte courante.

void unlink ()
 Procede a la deconnexion passive de la patte courante.

void stop ()
 Procede a l'arret des mouvements de la patte courante.

unsigned int getServoMotorCount () const
 Retourne le nombre de servo moteurs de la patte courante.

unsigned int getForceSensorCount () const
 Retourne le nombre de capteurs d'efforts de la patte courante.


Attributs Publics

Util * util
 Reference de l'instance de la classe specifique a la simulation d'une patte.


Membres protégés

 Leg (Atom *anAtom, int LegID)
 Constructeur d'une patte.

virtual ~Leg ()
 Destructeur d'une patte.

void setID (int aLegID)
 affecte l'identifiant de la patte courante

void setMappedID (int aMappedID)
 affecte le numero logique de la patte courante

void setAtom (Atom *anAtom)
 affecte l'atome proprietaire de la patte courante

Description détaillée

Classe definissant une patte.

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

Documentation des contructeurs et destructeurs

API::Leg::Leg (  Atom *  anAtom,
int  LegID
)  [protected]
 

Constructeur d'une patte.

Paramètres:
anAtom Reference de l'atome proprietaire de la patte
LegID Identifiant de la patte (0..5)

virtual API::Leg::~Leg (   )  [protected, virtual]
 

Destructeur d'une patte.

Documentation des méthodes

Atom* API::Leg::getAtom (   )  const
 

Retourne la reference de l'atome de la patte courante.

Renvoie:
L'instance de l'atome proprietaire de la patte

ForceSensor* API::Leg::getForceSensor (  unsigned int  aForceSensorID  )  const
 

Retourne la reference du capteur d'efforts donne en parametre de la patte courante.

Paramètres:
aForceSensorID numero identifiant le capteur d'efforts (0..2)
Renvoie:
La reference de l'une des instances de capteur d'effort de la patte courante

unsigned int API::Leg::getForceSensorCount (   )  const
 

Retourne le nombre de capteurs d'efforts de la patte courante.

Renvoie:
Le nombre de capteur d'efforts de la patte (normalement 3)

int API::Leg::getID (   )  const
 

Retourne l'identifiant de la patte courante.

Renvoie:
Le numero physique de la patte

IRReceiver* API::Leg::getIRReceiver (   )  const
 

Retourne la reference du recepteur IR de la patte courante.

Renvoie:
La reference de l'instance de recepteur Infra Rouge de la patte courante

IRSender* API::Leg::getIRSender (   )  const
 

Retourne la reference de l'emetteur IR de la patte courante.

Renvoie:
La reference de l'instance d'emetteur Infra Rouge de la patte courante

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

Retourne la reference de la connexion a laquelle participe la patte courante.

Renvoie:
L'instance de la connexion concernee par la patte

Leg* API::Leg::getLinkedLeg (   ) 
 

Retourne la reference de la patte liee a la patte courante.

Renvoie:
L'instnce de la patte liee a la patte

int API::Leg::getMappedID (   )  const
 

Retourne le numero logique de la patte courante.

Renvoie:
Le numero logique de la patte

std::string API::Leg::getMessage (   ) 
 

Retourne le premier message disponible de la patte courante.

Renvoie:
Le premier message disponible de la patte

CartesianPosition& API::Leg::getRelCartesianPosition (   )  const
 

Retourne la position cartesienne de l'extremite de la patte courante par rapport au centre de l'atome.

Renvoie:
La position relative de l'extremite (accroche) de la patte

ServoMotor* API::Leg::getServoMotor (  unsigned int  aServoMotorID  )  const
 

Retourne la reference du servomoteur donne en parametre de la patte courante.

Paramètres:
aServoMotorID Numero identifiant le servo moteur (0 ou 1)
Renvoie:
La reference de l'une des instances de servo moteur de la patte courante

unsigned int API::Leg::getServoMotorCount (   )  const
 

Retourne le nombre de servo moteurs de la patte courante.

Renvoie:
Le nombre de servo moteurs de la patte (normalement 2)

SphericPosition& API::Leg::getSphericPosition (   )  const
 

Retourne la position spherique de la patte courante.

Renvoie:
La position spherique de la patte

TouchSensor* API::Leg::getTouchSensor (   )  const
 

Retourne la reference du capteur de contact de la patte courante.

Renvoie:
La reference de l'instance du capteur de contact de la patte courante

bool API::Leg::isLinked (   )  const
 

Retourne si la patte est connectee.

Renvoie:
s'il y a une connexion, la valeur est vrai.

void API::Leg::sendMessage (  std::string  aMessage  ) 
 

Envoi d'un message passe en parametre a la patte connectee a la patte courante.

Paramètres:
aMessage Message a envoyer

void API::Leg::setAtom (  Atom *  anAtom  )  [protected]
 

affecte l'atome proprietaire de la patte courante

Paramètres:
anAtom Reference de l'atome proprietaire

void API::Leg::setID (  int  aLegID  )  [protected]
 

affecte l'identifiant de la patte courante

Paramètres:
aLegID Numero de la patte (0..5)

void API::Leg::setLink (  Leg *  aLeg  ) 
 

Prise en compte d'une connexion passive d'une patte passee en parametre avec la patte courante.

Paramètres:
aLeg Reference de la patte a connecter a la patte courante

void API::Leg::setMappedID (  int  aMappedID  )  [protected]
 

affecte le numero logique de la patte courante

Paramètres:
aMappedID Numero de la patte logique (0..5)

void API::Leg::stop (   ) 
 

Procede a l'arret des mouvements de la patte courante.

void API::Leg::unlink (   ) 
 

Procede a la deconnexion passive de la patte courante.

Documentation des fonctions amies et associées

friend class Atom [friend]
 

friend class Link [friend]
 

friend class Util [friend]
 

Documentation des données imbriquées

Util* API::Leg::util
 

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

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:22 2004 par doxygen 1.3.3