Finalisation Java doc

Author: MrTux31

Partie Java/python/Resultats/Metriques/MetriquesGlobales.csv

@@ -1,4 +1,4 @@
 algo,tempsAttenteMoyen,tempsReponseMoyen,makespan
 FIFO,7.0,27.4,65
 PRIORITE,7.0,27.4,65
-ROUND ROBIN,0.6,30.8,51
+ROUND ROBIN,4.6,28.0,53

Partie Java/python/Resultats/RoundRobin/rDetailled.csv

@@ -1,53 +1,9 @@
 idProcessus,dateDebut,dateFin,idProcesseur
-2,0,2,CPU1
-1,0,2,CPU2
-2,2,3,CPU1
-1,2,4,CPU2
-5,3,5,CPU1
-4,4,6,CPU2
-3,5,7,CPU1
-1,6,8,CPU2
-5,7,9,CPU1
-4,8,10,CPU2
-3,9,11,CPU1
-5,10,12,CPU2
-4,11,13,CPU1
-3,12,14,CPU2
-5,13,15,CPU1
-4,14,16,CPU2
-3,15,17,CPU1
-5,16,18,CPU2
-4,17,19,CPU1
-3,18,20,CPU2
-5,19,21,CPU1
-4,20,22,CPU2
-3,21,23,CPU1
-5,22,24,CPU2
-4,23,25,CPU1
-3,24,26,CPU2
-5,25,27,CPU1
-4,26,28,CPU2
-3,27,29,CPU1
-5,28,30,CPU2
-4,29,31,CPU1
-3,30,32,CPU2
-5,31,33,CPU1
-4,32,34,CPU2
-3,33,35,CPU1
-5,34,36,CPU2
-4,35,37,CPU1
-3,36,38,CPU2
-5,37,39,CPU1
-4,38,40,CPU2
-3,39,41,CPU1
-5,40,42,CPU2
-4,41,43,CPU1
-3,42,44,CPU2
-5,43,45,CPU1
-4,44,46,CPU2
-3,45,47,CPU1
-5,46,48,CPU2
-4,47,49,CPU1
-3,48,50,CPU2
-5,49,51,CPU1
-4,50,51,CPU2
+2,0,3,CPU1
+1,0,6,CPU2
+5,3,23,CPU1
+4,6,26,CPU2
+3,23,43,CPU1
+5,26,38,CPU2
+4,38,49,CPU2
+3,43,53,CPU1

Partie Java/python/Resultats/RoundRobin/rGlobaux.csv

@@ -1,6 +1,6 @@
 idProcessus,dateSoumission,dateDebut,dateFin,requiredRam,usedRam
 2,0,0,3,1024,1024
-1,0,0,8,1024,1024
-3,3,5,50,1024,1024
-5,3,3,51,1026,1026
-4,3,4,51,1025,1025
+1,0,0,6,1024,1024
+5,3,3,38,1026,1026
+4,3,6,49,1025,1025
+3,3,23,53,1024,1024

Partie Java/src/main/java/com/ordonnancement/Ordonnancement.java

@@ -9,6 +9,11 @@ public class Ordonnancement {
      * Point d'entrée de l'application d'ordonnancement
      *Cette classe lance l'interface graphique de l'application.
      * @param args
+     *@author ROMA Quentin
+    * @author Allemane Axel
+    * @author Olivencia Eliot
+    * @author Le Donné Antonin
+    * @author Ribeiro--Vaur Nino 
      */
     public static void main(String[] args) {
         OrdonnancementApp.runApp(args);       

Partie Java/src/main/java/com/ordonnancement/config/ConfigurationManager.java

@@ -8,6 +8,7 @@
  * Singleton responsable de la gestion du fichier de configuration de
  * l'ordonnanceur. Permet d'assurer qu'une seule configuration est utilisée dans
  * l'application.
+ * @author Allemane Axel
  */
 public class ConfigurationManager {
 

Partie Java/src/main/java/com/ordonnancement/config/DefaultPaths.java

@@ -1,22 +1,50 @@
 package com.ordonnancement.config;
 /**
  * Enum utilisé pour sauvegarder les chemins par défaut des fichiers (entrée / sortie) pour le fichier de configuration
+ *  @author Allemane Axel
  */
 public enum DefaultPaths {
 
+    /**
+     * Chemin du fichier des processus initiaux par défaut
+     */
     PROCESS_INIT("python/Settings/processusInitiaux.csv"), //Les processus initiaux
+    /**
+     * Chemin du ficher des ressources par défaut
+     */
     RESSOURCES_INIT("python/Settings/ressources.json"), //Le fichier des ressources dispos
+    /**
+     * Chemin du fichiers des métriques par défaut
+     */
     METRIQUES_GLOBAL("python/Resultats/Metriques/MetriquesGlobales.csv"), //Le fichier des métriques globales
     // ===================== FIFO =====================
+    /**
+     * Chemin des résultats détaillés de l'algo FIFO par défaut
+     */
     R_DETAILLED_FIFO("python/Resultats/Fifo/rDetailled.csv"),
+    /**
+     * Chemin des résultats globaux de l'algo FIFO par défaut
+     */
     R_GLOBAL_FIFO("python/Resultats/Fifo/rGlobaux.csv"),
 
     // ===================== PRIORITÉ =====================
+    /**
+     * Chemin des résultats détaillés de l'algo Priorité par défaut
+     */
     R_DETAILLED_PRIORITE("python/Resultats/Priorite/rDetailled.csv"),
+    /**
+     * Chemin des résultats globaux de l'algo Priorité par défaut
+     */
     R_GLOBAL_PRIORITE("python/Resultats/Priorite/rGlobaux.csv"),
 
     // ===================== ROUND ROBIN =====================
+     /**
+     * Chemin des résultats détaillés de l'algo Round Robin par défaut
+     */
     R_DETAILLED_RR("python/Resultats/RoundRobin/rDetailled.csv"),
+     /**
+     * Chemin des résultats globaux de l'algo Round Robin par défaut
+     */
     R_GLOBAL_RR("python/Resultats/RoundRobin/rGlobaux.csv");
 
 

Partie Java/src/main/java/com/ordonnancement/model/AlgoConfiguration.java

@@ -3,6 +3,7 @@
  * Classe permettant représentant un algorithme 
  * d'ordonnancement qui va etre executé par python.
  * Permet de regrouper toutes les informations concernant cet algorithme.
+ * @author ROMA Quentin
  */
 public class AlgoConfiguration {
 
@@ -39,24 +40,39 @@ public AlgoConfiguration(String nomAlgorithme, String fichierResultatsDetailles,
         this.quantum = quantum;
     }
 
+    /**
+     * Renvoie le nom de l'algorithme d'ordonnancement.
+     *
+     * @return le nom de l'algorithme
+     */
     public String getNomAlgorithme() {
         return nomAlgorithme;
     }
-
+    /**
+     * Renvoie le chemin du fichier contenant les résultats détaillés.
+     *
+     * @return le chemin du fichier des résultats détaillés
+     */
     public String getFichierResultatsDetailles() {
         return fichierResultatsDetailles;
     }
-
+    /**
+     * Renvoie le chemin du fichier contenant les résultats globaux.
+     *
+     * @return le chemin du fichier des résultats globaux
+     */
     public String getFichierResultatsGlobaux() {
         return fichierResultatsGlobaux;
     }
-
+    /**
+     * Renvoie le quantum utilisé par l'algorithme.
+     * Peut être null si l'algorithme n'en nécessite pas.
+     *
+     * @return le quantum, ou null si non applicable
+     */
     public Integer getQuantum() {
         return quantum;
     }
-
-
-
-     
+  
 
 }

Partie Java/src/main/java/com/ordonnancement/model/Allocation.java

@@ -45,10 +45,19 @@ public int getDateFinExecution() {
         return dateFinExecution;
     }
 
+    /**
+     * Renvoie l'identifiant du processus associé à cette allocation.
+     *
+     * @return l'identifiant du processus
+     */
     public String getIdProcessus(){
         return this.processus.getId();
     }
-
+    /**
+     * Renvoie le processus exécuté durant l'allocation.
+     *
+     * @return le processus concerné
+     */
     public Process getProcessus(){
         return this.processus;
     }

Partie Java/src/main/java/com/ordonnancement/model/ExecutionInfo.java

@@ -1,31 +1,43 @@
 package com.ordonnancement.model;
 
-import java.util.ArrayList;
-import java.util.List;
 
 /**
  * Classe permettant de regrouper les informations
  * d'une exécution d'un processus par un algorithme d'ordonnancement
+ * @author Ribeiro--Vaur Nino 
  */
 public class ExecutionInfo {
 
     //Calculé par python
     private final int dateDebut; //Date de début d'exécution du processus;
     private final int dateFin; //Date de fin d'exécution du processus
     private final int usedRam; //Qte de ram utilisée durant l'execution du processus
-
+    /**
+     * Constructeur
+     * @param dateDebut : la date de début de l'execution
+     * @param dateFin : la date de fin de l'execution
+     * @param usedRam : la quantité de ram utilisée
+     */
     public ExecutionInfo(int dateDebut, int dateFin, int usedRam) {
 
         this.dateDebut = dateDebut;
         this.dateFin = dateFin;
         this.usedRam = usedRam;
     }
 
-
+    /**
+     * Renvoie la date de début d'exécution du processus.
+     *
+     * @return la date de début d'exécution
+     */
     public int getDateDebut() {
         return dateDebut;
     }
-
+    /**
+     * Renvoie la quantité de RAM utilisée par le processus durant son exécution.
+     *
+     * @return la RAM utilisée
+     */
     public int getUsedRam(){
         return this.usedRam;
     }

Partie Java/src/main/java/com/ordonnancement/model/FileConfiguration.java

@@ -6,6 +6,7 @@
  * Classe représentant le fichier de configuration json utilisée dans python.
  * Elle de répertorier toutes les informations nécessaires à la
  * génération du fichier de configuration pour python
+ * @author Allemane Axel
  */
 public class FileConfiguration {
 
@@ -57,25 +58,40 @@ public FileConfiguration(String fichierProcessus, String fichierMetriquesGlobale
         this.listeAlgorithmes = List.copyOf(listeAlgorithmes); //Faire une copie de la liste pour empecher toutes modifs après
 
     }
-
+    /**
+     * Renvoie le chemin du fichier contenant la liste des processus à ordonnancer.
+     *
+     * @return le chemin du fichier des processus
+     */
     public String getFichierProcessus() {
         return fichierProcessus;
     }
-
+    /**
+     * Renvoie le chemin du fichier décrivant les ressources disponibles
+     * (processeurs, RAM).
+     *
+     * @return le chemin du fichier des ressources disponibles
+     */
     public String getFichierRessourcesDisponibles() {
         return fichierRessourcesDisponibles;
     }
 
-    /**
-     * Permet de récupérer la liste des algos d'ordonnancement qui vont seront
-     * utilisés par python ainsi que leur diverses configurations
+     /**
+     * Renvoie la liste des algorithmes d'ordonnancement à exécuter,
+     * accompagnés de leurs configurations (fichiers de sortie, quantum, etc.).
      *
-     * @return List<AlgoConfiguration>
+     * @return la liste des configurations d'algorithmes
      */
     public List<AlgoConfiguration> getListeAlgorithmes() {
         return this.listeAlgorithmes;
     }
 
+    /**
+     * Renvoie le chemin du fichier contenant les métriques globales
+     * produites par les ordonnancements.
+     *
+     * @return le chemin du fichier des métriques globales
+     */
     public String getFichierMetriquesGlobales() {
         return fichierMetriquesGlobales;
     }