feat(State.java): ajout commentaire

This commit is contained in:
2025-11-09 18:58:07 +01:00
parent 4514fd3204
commit f3d6a7d2ce

View File

@@ -1,13 +1,36 @@
/**
* State représente l'état de conduite d'une voiture.
* Il gère le mode de conduite actuel et fournit les paramètres associés
* tels que la consommation de carburant et l'intervalle de mouvement aléatoire.
*/
public class State public class State
{ {
/**
* Enum représentant les différents modes de conduite.
* Chaque mode définit :
* <ul>
* <li>carbUsed : carburant consommé par mouvement</li>
* <li>interval : intervalle pour générer un déplacement aléatoire</li>
* </ul>
*/
public static enum DriveMode public static enum DriveMode
{ {
// <CARBURANT PERDU> <PREMIER INTERVAL> <SECOND INTERVAL> //<CARBURANT PERDU> <PREMIER INTERVAL> <SECOND INTERVAL>
NORMAL(2, 1, 6); NORMAL(2, 1, 6);
public int carbUsed; /** Carburant consommé par mouvement dans ce mode */
public int[] interval; public final int carbUsed;
/** Intervalle aléatoire de déplacement pour ce mode : [min, max] */
public final int[] interval;
/**
* Constructeur du mode de conduite.
*
* @param carbUsed Carburant consommé par mouvement
* @param fInterval Intervalle minimum du déplacement aléatoire
* @param sInterval Intervalle maximum du déplacement aléatoire
*/
private DriveMode(int carbUsed, int fInterval, int sInterval) private DriveMode(int carbUsed, int fInterval, int sInterval)
{ {
this.carbUsed = carbUsed; this.carbUsed = carbUsed;
@@ -15,25 +38,40 @@ public class State
} }
} }
/** Mode de conduite courant */
private DriveMode current = DriveMode.NORMAL; private DriveMode current = DriveMode.NORMAL;
public DriveMode get() /**
{ * @return le mode de conduite actuel
return current; */
} public DriveMode get()
{
return current;
}
public int[] getInterval() /**
{ * @return l'intervalle de déplacement aléatoire du mode courant
return current.interval; */
} public int[] getInterval()
{
return current.interval;
}
public int getConsumption() /**
{ * @return la consommation de carburant du mode courant
return current.carbUsed; */
} public int getConsumption()
{
return current.carbUsed;
}
public void set(DriveMode DriveMode) /**
{ * Change le mode de conduite actuel.
current = DriveMode; *
} * @param mode nouveau mode de conduite
*/
public void setDriveMode(DriveMode mode)
{
current = mode;
}
} }