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

Classe definissant un servo moteur. Plus de détails...

#include <ServoMotor.h>

Diagramme de collaboration de API::ServoMotor:

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

Membres publics

int getID () const
 retourne l'identifiant du servo-moteur courant

Leg * getLeg () const
 retourne la reference de la patte du servo-moteur courant

int getTargetPosition () const
 retourne la position cible du servo-moteur courant

double getTargetAngle () const
 retourne l'angle cible du servo-moteur courant

double getTargetVelocity () const
 retourne la vitesse cible du servo-moteur courant

double getTargetForce () const
 retourne la force cible du servo-moteur courant

int getCurrentPosition () const
 retourne la position actuelle du servo-moteur courant

double getCurrentVelocity () const
 retourne la vitesse actuelle du servo-moteur courant

double getCurrentForce () const
 retourne la force actuelle du servo-moteur courant

double getCurrentAngle () const
 retourne l'angle actuel du servo-moteur courant

double getHighStopAngle () const
 retourne l'angle minimal du servo-moteur courant

double getLowStopAngle () const
 retourne l'angle maximal du servo-moteur courant

int getMinPosition () const
 retourne la position minimale du servo-moteur courant

int getMaxPosition () const
 retourne la position maximale du servo-moteur courant

void setToHalfPosition (int mode=KEEP, Real deltaTime=0, unsigned int index=0)
 Ordonne au servo-moteur de reprendre sa position canonique.

void setTargetAngle (double aTargetAngle, int mode=KEEP, Real deltaTime=0, unsigned int index=0)
 Affecte au servo-moteur un angle cible.

void setTargetPosition (int aTargetPosition, int mode=KEEP, Real deltaTime=0, unsigned int index=0)
 Affecte au servo-moteur une position cible.

void setTargetVelocity (int aTargetVelocity, int mode=KEEP, Real deltaTime=0, unsigned int index=0)
 Affecte au servo-moteur une vitesse cible.

void setTargetForce (double aTargetForce, int mode=KEEP, Real deltaTime=0, unsigned int index=0)
 Affecte au servo-moteur une force cible.

void stop ()
 procede a l'arret du servo-moteur


Attributs Publics

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


Membres protégés

 ServoMotor ()
 constructeur du servo-moteur

 ~ServoMotor ()
 destructeur du servo-moteur

void setID (int aServoMotorID)
 affecte l'identifiant du servo-moteur courant

void setLeg (Leg *aLeg)
 affecte la patte proprietaire du servo-moteur courant

Description détaillée

Classe definissant un servo moteur.

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

Documentation des contructeurs et destructeurs

API::ServoMotor::ServoMotor (   )  [protected]
 

constructeur du servo-moteur

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

destructeur du servo-moteur

Documentation des méthodes

double API::ServoMotor::getCurrentAngle (   )  const
 

retourne l'angle actuel du servo-moteur courant

Renvoie:
l'angle actuel du servo-moteur (getLowStopAngle()..getHighStopAngle())

double API::ServoMotor::getCurrentForce (   )  const
 

retourne la force actuelle du servo-moteur courant

Renvoie:
la force actuelle du servo-moteur (en newton)

int API::ServoMotor::getCurrentPosition (   )  const
 

retourne la position actuelle du servo-moteur courant

Renvoie:
la position actuelle du servo-moteur (getMinPosition()..getMaxPosition())

double API::ServoMotor::getCurrentVelocity (   )  const
 

retourne la vitesse actuelle du servo-moteur courant

Renvoie:
la vitesse actuelle du servo-moteur (en radians/sec)

double API::ServoMotor::getHighStopAngle (   )  const
 

retourne l'angle minimal du servo-moteur courant

Renvoie:
l'angle minimal du servo-moteur (en radians)

int API::ServoMotor::getID (   )  const
 

retourne l'identifiant du servo-moteur courant

Renvoie:
le numero de l'atome

Leg* API::ServoMotor::getLeg (   )  const
 

retourne la reference de la patte du servo-moteur courant

Renvoie:
l'instance de la patte qui est concernee par le servo-moteur

double API::ServoMotor::getLowStopAngle (   )  const
 

retourne l'angle maximal du servo-moteur courant

Renvoie:
l'angle maximal du servo-moteur (en radians)

int API::ServoMotor::getMaxPosition (   )  const
 

retourne la position maximale du servo-moteur courant

Renvoie:
la position maximale du servo-moteur (en unite)

int API::ServoMotor::getMinPosition (   )  const
 

retourne la position minimale du servo-moteur courant

Renvoie:
la position minimale du servo-moteur (en unite)

double API::ServoMotor::getTargetAngle (   )  const
 

retourne l'angle cible du servo-moteur courant

Renvoie:
l'angle cible du servo-moteur (en radians, getLowStopAngle()..getHighStopAngle())

double API::ServoMotor::getTargetForce (   )  const
 

retourne la force cible du servo-moteur courant

Renvoie:
la force cible du servo-moteur (en newton)

int API::ServoMotor::getTargetPosition (   )  const
 

retourne la position cible du servo-moteur courant

Renvoie:
la position cible du servo-moteur (getMinPosition()..getMaxPosition())

double API::ServoMotor::getTargetVelocity (   )  const
 

retourne la vitesse cible du servo-moteur courant

Renvoie:
la vitesse cible du servo-moteur (en radians/sec)

void API::ServoMotor::setID (  int  aServoMotorID  )  [protected]
 

affecte l'identifiant du servo-moteur courant

Paramètres:
aServoMotorID numero du servo-moteur

void API::ServoMotor::setLeg (  Leg *  aLeg  )  [protected]
 

affecte la patte proprietaire du servo-moteur courant

Paramètres:
aLeg reference du servo-moteur

void API::ServoMotor::setTargetAngle (  double  aTargetAngle,
int  mode = KEEP,
Real  deltaTime = 0,
unsigned int  index = 0
) 
 

Affecte au servo-moteur un angle cible.

Paramètres:
aTargetAngle Angle cible en radians (getLowStopAngle()..getHighStopAngle())
mode indique si l'ordre est immediat (REPLACE) ou sequentiel (KEEP)
deltaTime indique le delai minimal avant le debut de l'execution de l'ordre
index indique l'ensemble de synchronisation de l'appel. [0 .. ]. 0 indique aucun ensemble de synchronisation

void API::ServoMotor::setTargetForce (  double  aTargetForce,
int  mode = KEEP,
Real  deltaTime = 0,
unsigned int  index = 0
) 
 

Affecte au servo-moteur une force cible.

Paramètres:
aTargetForce Force cible en newton
mode indique si l'ordre est immediat (REPLACE) ou sequentiel (KEEP)
deltaTime indique le delai minimal avant le debut de l'execution de l'ordre
index indique l'ensemble de synchronisation de l'appel. [0 .. ]. 0 indique aucun ensemble de synchronisation

void API::ServoMotor::setTargetPosition (  int  aTargetPosition,
int  mode = KEEP,
Real  deltaTime = 0,
unsigned int  index = 0
) 
 

Affecte au servo-moteur une position cible.

Paramètres:
aTargetPosition Position cible en unite (getMinPosition()..getMaxPosition())
mode indique si l'ordre est immediat (REPLACE) ou sequentiel (KEEP)
deltaTime indique le delai minimal avant le debut de l'execution de l'ordre
index indique l'ensemble de synchronisation de l'appel. [0 .. ]. 0 indique aucun ensemble de synchronisation

void API::ServoMotor::setTargetVelocity (  int  aTargetVelocity,
int  mode = KEEP,
Real  deltaTime = 0,
unsigned int  index = 0
) 
 

Affecte au servo-moteur une vitesse cible.

Paramètres:
aTargetVelocity Vitesse cible en radians par seconde
mode indique si l'ordre est immediat (REPLACE) ou sequentiel (KEEP)
deltaTime indique le delai minimal avant le debut de l'execution de l'ordre
index indique l'ensemble de synchronisation de l'appel. [0 .. ]. 0 indique aucun ensemble de synchronisation

void API::ServoMotor::setToHalfPosition (  int  mode = KEEP,
Real  deltaTime = 0,
unsigned int  index = 0
) 
 

Ordonne au servo-moteur de reprendre sa position canonique.

Paramètres:
mode indique si l'ordre est immediat (REPLACE) ou sequentiel (KEEP)
deltaTime indique le delai minimal avant le debut de l'execution de l'ordre
index donne l'index de synchronisation. La valeur 0 indique aucun synchronisation

void API::ServoMotor::stop (   ) 
 

procede a l'arret du servo-moteur

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::ServoMotor::util
 

Reference de l'instance de la classe specifique a la simulation d'un servo-moteur.

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