diff --git a/src/State.java b/src/State.java index 148d39a..74470e4 100644 --- a/src/State.java +++ b/src/State.java @@ -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 { + /** + * Enum représentant les différents modes de conduite. + * Chaque mode définit : + * + */ public static enum DriveMode { -// + // NORMAL(2, 1, 6); - public int carbUsed; - public int[] interval; + /** Carburant consommé par mouvement dans ce mode */ + 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) { this.carbUsed = carbUsed; @@ -15,25 +38,40 @@ public class State } } + /** Mode de conduite courant */ private DriveMode current = DriveMode.NORMAL; - public DriveMode get() - { - return current; - } + /** + * @return le mode de conduite actuel + */ + public DriveMode get() + { + return current; + } - public int[] getInterval() - { - return current.interval; - } + /** + * @return l'intervalle de déplacement aléatoire du mode courant + */ + public int[] getInterval() + { + return current.interval; + } - public int getConsumption() - { - return current.carbUsed; - } + /** + * @return la consommation de carburant du mode courant + */ + public int getConsumption() + { + return current.carbUsed; + } - public void set(DriveMode DriveMode) - { - current = DriveMode; - } + /** + * Change le mode de conduite actuel. + * + * @param mode nouveau mode de conduite + */ + public void setDriveMode(DriveMode mode) + { + current = mode; + } }