Référence de la classe PeriodicProcess

Classe à implémenter pour gérer les appels dans la loop. Plus de détails...

#include <PeriodicProcess.h>

Dérivée par BrushlessMotor, DifferentialController, FullSpeedServo, Odometry, et PositionController.

Fonctions membres publiques
virtual	~PeriodicProcess ()
	Constructeur de PeriodicProcess.
void	enable ()
	Active le PeriodicProcess.
void	disable ()
	Désactive le PeriodicProcess.
void	setTimestep (float timestep)
	Sélectionne une nouvelle valeur pour timestep.
bool	update ()
	Execute la méthode process.
bool	isEnabled () const
	Vérifie si le PeriodicProcess est activé.
float	getTimestep () const
	Retourne la valeur de m_timestep.

Fonctions membres protégées
virtual void	process (float timestep)=0
	Méthode à implémenter obligatoirement pour hériter de PeriodicProcess.
virtual void	onProcessEnabling ()
	Méthode exécutée à l'activation du PeriodicProcess.
virtual void	onProcessDisabling ()
	Méthode exécutée à la désactivation du PeriodicProcess.

Description détaillée

Classe à implémenter pour gérer les appels dans la loop.

class PeriodicProcess

est un outil permettant à l'Arduino de pouvoir appeler l'objet PeriodicProcess tout les X s. Cela permet de ne pas saturer le microcontroleur pour des tâches qui ne nécessitent pas un très gros rafraichissement. En général, on l'utilise pour toutes les tâches dans la loop.

Par exemple : faire tourner un moteur pendant un certain temps puis l'arreter en autonomie sans delay()

Documentation des constructeurs et destructeur

~PeriodicProcess()

virtual PeriodicProcess::~PeriodicProcess ( )

inlinevirtual

Constructeur de PeriodicProcess.

Le constructeur est totalement vide.

Documentation des fonctions membres

disable()

void PeriodicProcess::disable

(

)

Désactive le PeriodicProcess.

Passe la variable m_enable à Faux et execute onProcessDisabling.

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

enable()

void PeriodicProcess::enable

(

)

Active le PeriodicProcess.

Passe la variable m_enable à Vrai et execute onProcessEnabling.

Voici le graphe d'appel pour cette fonction :

getTimestep()

float PeriodicProcess::getTimestep ( ) const

inline

Retourne la valeur de m_timestep.

Renvoie

La valeur de m_timestep.

isEnabled()

bool PeriodicProcess::isEnabled ( ) const

inline

Vérifie si le PeriodicProcess est activé.

Renvoie

La valeur de m_enabled.

onProcessDisabling()

virtual void PeriodicProcess::onProcessDisabling ( )

inlineprotectedvirtual

Méthode exécutée à la désactivation du PeriodicProcess.

Méthode à implémenter si votre class nécessite des actions à sa déactivation.

Voici le graphe des appelants de cette fonction :

onProcessEnabling()

virtual void PeriodicProcess::onProcessEnabling ( )

inlineprotectedvirtual

Méthode exécutée à l'activation du PeriodicProcess.

Méthode à implémenter si votre class nécessite des actions à son activation.

Réimplémentée dans DifferentialController, et VelocityController.

Voici le graphe des appelants de cette fonction :

process()

virtual void PeriodicProcess::process ( float timestep )

protectedpure virtual

Méthode à implémenter obligatoirement pour hériter de PeriodicProcess.

Process est la méthode qui s'exécutera toutes les m_timestep. Il doit donc définir l'action répétitive voulue dans la loop de l'Arduino.

Paramètres

timestep

Temps écoulé depuis le dernier appel en seconde.

Implémenté dans DifferentialController, FullSpeedServo, Odometry, et VelocityController.

Voici le graphe des appelants de cette fonction :

setTimestep()

void PeriodicProcess::setTimestep ( float timestep )

inline

Sélectionne une nouvelle valeur pour timestep.

Change le timestep par celui donné en paramètre.

Paramètres

timestep

Temps en secondes du taux de rafraichissement.

update()

bool PeriodicProcess::update

(

)

Execute la méthode process.

Execute la méthode process si le temps passé est supérieur à timestep. Envoie à process le temps depuis le dernier appel.

Renvoie

Vrai si process a été lancé et Faux sinon.

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

---

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

• C:/Users/boris/Desktop/robotique/team2024/platformIO/LIBS/ARDUINO_LIBS/PeriodicProcess/PeriodicProcess.h
• C:/Users/boris/Desktop/robotique/team2024/platformIO/LIBS/ARDUINO_LIBS/PeriodicProcess/PeriodicProcess.cpp