Référence de la classe Codewheel

Fait la passerelle entre les roues codeuses et le stm32. Plus de détails...

#include <Codewheel.h>

Graphe d'héritage de Codewheel:

Graphe de collaboration de Codewheel:

Fonctions membres publiques
	Codewheel (TIM_HandleTypeDef *htim)
	Constructeur pour une roue codeuse.
long	getCounter ()
	renvoie le compteur de la roue codeuse
long	getCountsPerRev ()
	Donne le nombre de tics par tour courant.
float	getWheelRadius ()
	Donne le rayon de la roue en mm.
void	setCountsPerRev (long countsPerRev)
	Set le nombre de tics par tour.
void	setWheelRadius (float wheelRadius)
	Set le rayon en mm de la roue.
void	reset ()
	Réinitialise le compteur à 0.
float	getTraveledDistance ()
	Donne la distance parcouru.
float	restart ()
	Donne la distance parcouru et reset le compteur.

Attributs publics
TIM_HandleTypeDef *	m_htim
TIM_TypeDef *	m_tim

Fonctions membres protégées
void	update ()
	Récupère le nombre de tics stoqués dans le compteur.

Attributs protégés
long	m_currentCounter
	Tic courant.
long	m_startCounter
	Tic depuis le dernier reset.
float	m_wheelRadius
	Rayon de la roue codeuse en mm.
long	m_countsPerRev
	Nombre de tics par tour de roue.

Description détaillée

Fait la passerelle entre les roues codeuses et le stm32.

class Codewheel

Auteur

Boris HILKENS Cette classe permet de récupérer les tics des roues codeuses à travers le timer du STM32.

Documentation des constructeurs et destructeur

Codewheel()

Codewheel::Codewheel

(

TIM_HandleTypeDef *

htim

)

Constructeur pour une roue codeuse.

Paramètres

htim	Timer utilisé par la roue codeuse

Avertissement

Que pour STM32

Documentation des fonctions membres

getCounter()

long Codewheel::getCounter ( )

inline

renvoie le compteur de la roue codeuse

Renvoie

m_currentCounter

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getCountsPerRev()

long Codewheel::getCountsPerRev ( )

inline

Donne le nombre de tics par tour courant.

Renvoie

long Nombre de tics par tour.

getTraveledDistance()

float Codewheel::getTraveledDistance ( )

virtual

Donne la distance parcouru.

Renvoie la distance parcourue par la roue codeuse.

Cette méthode donne la distance parcouru par la roue depuis le dernier Codewheel::reset ou Codewheel::restart.

Renvoie

float

distance parcourue en mm

Implémente AbstractCodewheel.

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getWheelRadius()

float Codewheel::getWheelRadius ( )

inline

Donne le rayon de la roue en mm.

Renvoie

float rayon en mm.

reset()

void Codewheel::reset

(

)

Réinitialise le compteur à 0.

Remet à zero le counter de départ.

Cette méthode peut rendre caduque le prochain Codewheel::getTraveledDistance.

restart()

float Codewheel::restart ( )

virtual

Donne la distance parcouru et reset le compteur.

Renvoie la distance parcourue entre le dernier appel de restart.

Cette méthode appel la méthode Codewheel::getTravemedDistance avant de mettre à jour le compteur de l'arduino (pas du compteur (puce elec)).

Renvoie

float

distance relative au dernier appel de restart

Implémente AbstractCodewheel.

Voici le graphe d'appel pour cette fonction :

setCountsPerRev()

void Codewheel::setCountsPerRev

(

long

countsPerRev

)

Set le nombre de tics par tour.

Modifie la variable des current_points par révolution de la roue codeuse.

Paramètres

countsPerRev	nb de tics par tour.
countsPerRev	point par révolution

setWheelRadius()

void Codewheel::setWheelRadius

(

float

wheelRadius

)

Set le rayon en mm de la roue.

Modifie le rayon de la roue codeuse.

Paramètres

wheelRadius	rayon en mm.
wheelRadius	rayon de la roue codeuse en mm

update()

void Codewheel::update ( )

protected

Récupère le nombre de tics stoqués dans le compteur.

Met à jour le compteur.

Avertissement

Que pour STM32

Voici le graphe des appelants de cette fonction :

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• lib/Codewheel/Codewheel.h
• lib/Codewheel/Codewheel.cpp