Référence de la classe WheelMotor

Implémentation concrète d'un moteur de roue. Plus de détails...

#include <WheelMotor.h>

Graphe d'héritage de WheelMotor:

Graphe de collaboration de WheelMotor:

Fonctions membres publiques
	WheelMotor (float maxVelocity=1.0f)
	Construit un moteur de roue.
float	getMaxVelocity () const override
	Retourne la vitesse maximale configurée.
void	setMaxVelocity (float maxVelocity)
	Modifie la vitesse maximale (limitation logicielle).
float	getConstant () const
	Renvoie la constante du moteur paramétrée.
float	getWheelRadius () const
	Renvoie le rayon de la roue du moteur.
void	setWheelRadius (float wheelRadius)
	Paramètre le rayon de la roue liée au moteur.
void	setVelocity (float velocity) override
	Envoie une commande de vitesse au moteur.
void	setConstant (float constant)
	Paramètre la constante du moteur.
	WheelMotor (float maxVelocity=1.0f)
	Construit un moteur de roue.
float	getMaxVelocity () const override
	Retourne la vitesse maximale configurée.
void	setMaxVelocity (float maxVelocity)
	Modifie la vitesse maximale (limitation logicielle).
float	getConstant () const
	Renvoie la constante du moteur paramétrée.
float	getWheelRadius () const
	Renvoie le rayon de la roue du moteur.
void	setWheelRadius (float wheelRadius)
	Paramètre le rayon de la roue liée au moteur.
void	setVelocity (float velocity) override
	Envoie une commande de vitesse au moteur.
void	setConstant (float constant)
	Paramètre la constante du moteur.
Fonctions membres publiques hérités de AbstractMotor
virtual	~AbstractMotor ()=default
	Destructeur virtuel.
virtual	~AbstractMotor ()=default
	Destructeur virtuel.

Membres hérités additionnels
Attributs publics hérités de AbstractMotor
AbstractDriver *	m_driver = nullptr
uint8_t	m_driverId = 255

Description détaillée

Implémentation concrète d'un moteur de roue.

Cette classe permet de définir les limites physiques d'un moteur et de le lier à un canal spécifique d'un AbstractDriver.

Documentation des constructeurs et destructeur

WheelMotor() [1/2]

WheelMotor::WheelMotor ( float maxVelocity = 1.0f )

explicit

Construit un moteur de roue.

Paramètres

maxVelocity

Vitesse maximale autorisée (généralement 1.0f pour 100%).

WheelMotor() [2/2]

WheelMotor::WheelMotor ( float maxVelocity = 1.0f )

explicit

Construit un moteur de roue.

Paramètres

maxVelocity

Vitesse maximale autorisée (généralement 1.0f pour 100%).

Documentation des fonctions membres

getConstant() [1/2]

float WheelMotor::getConstant ( ) const

inline

Renvoie la constante du moteur paramétrée.

Renvoie

Constante : (60 * reduction_ratio / velocity_constant_in_RPM) / supplied_voltage_in_V

Voici le graphe des appelants de cette fonction :

getConstant() [2/2]

float WheelMotor::getConstant ( ) const

inline

Renvoie la constante du moteur paramétrée.

Renvoie

Constante : (60 * reduction_ratio / velocity_constant_in_RPM) / supplied_voltage_in_V

getMaxVelocity() [1/2]

float WheelMotor::getMaxVelocity ( ) const

nodiscardoverridevirtual

Retourne la vitesse maximale configurée.

Renvoie

Vitesse maximale.

Implémente AbstractMotor.

getMaxVelocity() [2/2]

float WheelMotor::getMaxVelocity ( ) const

nodiscardoverridevirtual

Retourne la vitesse maximale configurée.

Renvoie

Vitesse maximale.

Implémente AbstractMotor.

getWheelRadius() [1/2]

float WheelMotor::getWheelRadius ( ) const

inline

Renvoie le rayon de la roue du moteur.

Renvoie

Rayon en mm.

Voici le graphe des appelants de cette fonction :

getWheelRadius() [2/2]

float WheelMotor::getWheelRadius ( ) const

inline

Renvoie le rayon de la roue du moteur.

Renvoie

Rayon en mm.

setConstant() [1/2]

void WheelMotor::setConstant

(

float

constant

)

Paramètre la constante du moteur.

Paramètres

constant

Constante en rad/s/Volt.

Voici le graphe des appelants de cette fonction :

setConstant() [2/2]

void WheelMotor::setConstant

(

float

constant

)

Paramètre la constante du moteur.

Paramètres

constant

Constante en rad/s/Volt.

setMaxVelocity() [1/2]

void WheelMotor::setMaxVelocity

(

float

maxVelocity

)

Modifie la vitesse maximale (limitation logicielle).

Paramètres

maxVelocity

Nouvelle vitesse maximale.

setMaxVelocity() [2/2]

void WheelMotor::setMaxVelocity

(

float

maxVelocity

)

Modifie la vitesse maximale (limitation logicielle).

Paramètres

maxVelocity

Nouvelle vitesse maximale.

setVelocity() [1/2]

void WheelMotor::setVelocity ( float velocity )

overridevirtual

Envoie une commande de vitesse au moteur.

Paramètres

velocity

Vitesse de commande en mm/s.

Réimplémentée à partir de AbstractMotor.

Voici le graphe des appelants de cette fonction :

setVelocity() [2/2]

void WheelMotor::setVelocity ( float velocity )

overridevirtual

Envoie une commande de vitesse au moteur.

Paramètres

velocity

Vitesse de commande en mm/s.

Réimplémentée à partir de AbstractMotor.

setWheelRadius() [1/2]

void WheelMotor::setWheelRadius

(

float

wheelRadius

)

Paramètre le rayon de la roue liée au moteur.

Paramètres

wheelRadius

Rayon en mm.

Voici le graphe des appelants de cette fonction :

setWheelRadius() [2/2]

void WheelMotor::setWheelRadius

(

float

wheelRadius

)

Paramètre le rayon de la roue liée au moteur.

Paramètres

wheelRadius

Rayon en mm.

---

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

• motors/include/WheelMotor.h
• Wheeledbase/lib/motors/include/WheelMotor.h
• motors/src/WheelMotor.cpp
• Wheeledbase/lib/motors/src/WheelMotor.cpp