Diff: Odometry/Odometry.h

Revision:

6:f54df7542988

Parent:

3:62e9d715de65

Child:

7:961c1acdf753

diff -r 71b6c6b7a4ce -r f54df7542988 Odometry/Odometry.h
--- a/Odometry/Odometry.h	Tue Nov 24 22:06:52 2015 +0000
+++ b/Odometry/Odometry.h	Tue Nov 24 22:26:09 2015 +0000
@@ -16,8 +16,16 @@
 class Odometry
 {
     public:
+        /** Constructeur standart
+        * @param diameter_right Definit le diametre de la roue droite
+        * @param diameter_left Definit le diametre de la roue gauche
+        * @param v Definit l'entraxe du robot
+        * @param rc Definit une reference vers l'objet permettant l'asserv des moteurs
+            @note Cet objet doit etre initialise en amont
+        */
         Odometry(double diameter_right, double diameter_left, double v, RoboClaw &rc);
         
+        /** Les fonctions suivantes permettent de réinitialiser les valeurs de position de l'odometrie. */
         void setPos(double x, double y, double theta);
         void setX(double x);
         void setY(double y);