Merge pull request #44 from sapk-tb/etape-5

Merge Etape 5

src/Simulateur.java

@@ -49,7 +49,7 @@ public class Simulateur {
     private Integer seed = null;
     /**
      * la longueur du message aléatoire à transmettre si un message n'est pas
-     * impose
+     * imposé
      */
     private int nbBitsMess = 100;
     /**
@@ -149,8 +149,8 @@ public class Simulateur {
 
     private boolean transducteur = false; //Active le transducteur
 
-    private boolean noMultiCorrection = false; // déssactive la correction des multi-trajets
-    private boolean quickMode = false; // Simplifie certains calcul (bruit gaussien)
+    private boolean noMultiCorrection = false; // désactive la correction des multi-trajets
+    private boolean quickMode = false; // Simplifie certains calculs (bruit gaussien)
     private boolean aveugle = false; // Mode aveugle pour le recepeteur
     private Integer nbSymParOeil = 2;
 
@@ -302,7 +302,7 @@ public Simulateur(String[] args) throws ArgumentsException, Exception {
     }
 
     /**
-     * La méthode analyseArguments extrait d'un tableau de chaines de caractéres
+     * La méthode analyseArguments extrait d'un tableau de chaines de caractères
      * les différentes options de la simulation. Elle met à jour les attributs
      * du Simulateur.
      *
@@ -492,7 +492,7 @@ public final void analyseArguments(String[] args) throws ArgumentsException {
                 nbTrajet = 0;
                 for (int j = 0; j < 5; j++) {
                     if (ar[j] != 0) {
-                        nbTrajet++; //nbTrajet indique le nombre de trajet non null qui seront généré mais n'est pas indispensable
+                        nbTrajet++; //nbTrajet indique le nombre de trajets non null qui seront générés mais n'est pas indispensable
                     }
                 }
                 System.out.println("nbTrajet : " + nbTrajet);

src/automates/AutomateTransducteur.java

@@ -7,7 +7,7 @@
 public class AutomateTransducteur {
 
 	/**
-	 * méthode qui test si le tableau de boolean passé en paramètre est valide ou nono
+	 * méthode qui teste si le tableau de boolean passé en paramètre est valide ou non
 	 */
 	public void AutomateTransducteur(){
 

src/emetteurs/Emetteur.java

@@ -7,10 +7,10 @@
 import java.util.*;
 
 /**
- * Classe Abstraite d'un composant emetteur d'informations dont les élèments
+ * Classe Abstraite d'un composant emetteur d'informations dont les éléments
  * sont de type R en entrée et de type E en sortie; l'entrée de emetteur
  * implémente l'interface DestinationInterface, la sortie de emetteur
- * implémente l'interface SourceInterface
+ * implémente l'interface SourceInterface.
  *
  * @author Antoine GIRARD
  * @author Cédric HERZOG
@@ -75,7 +75,7 @@ public void connecter(DestinationInterface<E> destination) {
     }
 
     /**
-     * déconnecte une destination de la la sortie de emetteur
+     * déconnecte une destination de la sortie de emetteur
      *
      * @param destination la destination à déconnecter
      */

src/emetteurs/EmetteurAnalogique.java

@@ -5,8 +5,8 @@
 import information.InformationNonConforme;
 
 /**
- * Classe d'un composant emetteur d'informations dont les élèments sont de type
- * EmetteurAnalogique qui hérite de la classe Emetteur
+ * Classe d'un composant emetteur d'informations dont les éléments sont de type
+ * EmetteurAnalogique qui hérite de la classe Emetteur.
  *
  * @author Antoine GIRARD
  * @author Cédric HERZOG
@@ -50,11 +50,11 @@ public double getDutyCycleRZ() {
      * un constructeur de l'émetteur analogique
      *
      * @param form Forme du signal à émettre
-     * @param nbEch Nombre d'écahntillon par symbole
+     * @param nbEch Nombre d'échantillons par symbole
      * @param amplMin Amplitude pour la valeur binaire 0
      * @param amplMax Amplitude pour la valeur binaire 1
      * @param dutyCycleRZ Dutycycle à utiliser dans le cadre d'une forme RZ
-     * @param tmpMontee Temps de montée à respecté dans le cadre d'une forme
+     * @param tmpMontee Temps de montée à respecter dans le cadre d'une forme
      * NRZT
      */
     public EmetteurAnalogique(String form, int nbEch, double amplMin, double amplMax, double dutyCycleRZ, double tmpMontee) {

src/information/Information.java

@@ -3,14 +3,14 @@
 import java.util.*;
 
 /**
- * La classe Information sert à contenir des d'un signal logique ou numérique.
+ * La classe Information sert à contenir des informations d'un signal logique ou numérique.
  *
  * @author prou
  * @author Antoine GIRARD
  * @author Cédric HERZOG
  * @author Pierrick CHOVELON
  * @author Mélanie CORRE
- * @param <T> Le format des donnée dans l'information
+ * @param <T> Le format des données dans l'information
  */
 public class Information<T> implements Iterable<T> {
 
@@ -44,7 +44,7 @@ public Information(Information<T> Inf) {
     /**
      * pour construire à partir d'un tableau de T une information
      *
-     * @param content le tableau d'élèments pour initialiser l'information
+     * @param content le tableau d'éléments pour initialiser l'information
      * construite
      */
     public Information(T[] content) {
@@ -59,9 +59,9 @@ public Information(T[] content) {
     }
 
     /**
-     * pour connaitre le nombre d'élèments d'une information
+     * pour connaitre le nombre d'éléments d'une information
      *
-     * @return le nombre d'élèments de l'information
+     * @return le nombre d'éléments de l'information
      */
     public int nbElements() {
         return this.content.size();
@@ -78,7 +78,7 @@ public Stream<T> getStream() {
      }
      //*/
     /**
-     * pour renvoyer un tableau basique d'élèment d'une information
+     * pour renvoyer un tableau basique d'éléments d'une information
      *
      * @param array Le tableau a remplir avec les valeurs
      */
@@ -89,9 +89,9 @@ public void toArray(T[] array) {
 
     //*/
     /**
-     * pour renvoyer un élèment d'une information
+     * pour renvoyer un élément d'une information
      *
-     * @param i indice de l'élèmetn à retourné
+     * @param i indice de l'élément à retourner
      * @return le ieme élèment de l'information
      */
     public T iemeElement(int i) {
@@ -101,27 +101,27 @@ public T iemeElement(int i) {
     /**
      * pour modifier le ième élèment d'une information
      *
-     * @param i indice de l'élèmetn à modifier
+     * @param i indice de l'élément à modifier
      * @param v valeur à modifier
      */
     public void setIemeElement(int i, T v) {
         this.content.set(i, v);
     }
 
     /**
-     * pour ajouter un élèment à la fin de l'information
+     * pour ajouter un élément à la fin de l'information
      *
-     * @param valeur l'élèment à rajouter
+     * @param valeur l'élément à rajouter
      */
     public void add(T valeur) {
         this.content.add(valeur);
     }
 
     /**
-     * pour ajouter un élèment à la fin de l'information
+     * pour ajouter un élément à la fin de l'information
      *
      * @param i index
-     * @param valeur l'élèment à rajouter
+     * @param valeur l'élément à rajouter
      */
     public void addAt(int i, T valeur) {
         this.content.add(i, valeur);
@@ -131,7 +131,7 @@ public void addAt(int i, T valeur) {
      * pour comparer l'information courante avec une autre information
      *
      * @param o l'information avec laquelle se comparer
-     * @return "true" si les 2 informations contiennent les mêmes élèments aux
+     * @return "true" si les 2 informations contiennent les mêmes éléments aux
      * mêmes places; "false" dans les autres cas
      */
     @SuppressWarnings("unchecked")

src/recepteurs/Recepteur.java

@@ -7,7 +7,7 @@
 import java.util.*;
 
 /**
- * Classe Abstraite d'un composant recepteur d'informations dont les élèments
+ * Classe Abstraite d'un composant recepteur d'informations dont les éléments
  * sont de type R en entrée et de type E en sortie; l'entrée du recepteur
  * implémente l'interface DestinationInterface, la sortie du recepteur
  * implémente l'interface SourceInterface
@@ -82,7 +82,7 @@ public void deconnecter(DestinationInterface<E> destination) {
 
     /**
      * reçoit une information. Cette méthode, en fin d'exécution, appelle la
-     * méthode émettre.
+     * méthode emettre.
      *
      * @param information l'information reçue
      */

src/recepteurs/RecepteurAnalogique.java

@@ -5,7 +5,7 @@
 import information.InformationNonConforme;
 
 /**
- * Classe d'un composant recepteur d'informations dont les élèments sont de type
+ * Classe d'un composant recepteur d'informations dont les éléments sont de type
  * RecepteurAnalogique qui hérite de la classe Recepteur
  *
  * @author Antoine GIRARD
@@ -50,11 +50,11 @@ public double getTmpMontee() {
      * Constructeur du récepteur analogique
      *
      * @param form Forme du signal à recevoir
-     * @param nbEch Nombre d'écahntillon par symbole
+     * @param nbEch Nombre d'échantillons par symbole
      * @param amplMin Amplitude pour la valeur binaire 0
      * @param amplMax Amplitude pour la valeur binaire 1
      * @param dutyCycleRZ Dutycycle à utiliser dans le cadre d'une forme RZ
-     * @param tmpMontee Temps de montée à respecté dans le cadre d'une forme
+     * @param tmpMontee Temps de montée à respecter dans le cadre d'une forme
      * NRZT
      */
     public RecepteurAnalogique(String form, int nbEch, double amplMin, double amplMax, double dutyCycleRZ, double tmpMontee) {
@@ -80,10 +80,10 @@ public void recevoir(Information<Double> information) throws InformationNonConfo
     }
 
     /**
-     * Analyze un information contenant des échantillon et en détermine les
-     * valaurs binaires en se basant sur les apramètres du recepteur
+     * Analyse un information contenant des échantillons et en détermine les
+     * valeurs binaires en se basant sur les paramètres du recepteur
      *
-     * @param infRecue l'information contenant les d'échantillon
+     * @param infRecue l'information contenant les échantillons
      * @return les information binaire déduite
      * @throws InformationNonConforme
      */
@@ -130,7 +130,7 @@ protected Information<Boolean> parseEch(Information<Double> infRecue) throws Inf
     }
 
     /**
-     * Envoie l'informationEmise aux élément connectés
+     * Envoie l'informationEmise aux éléments connectés
      *
      * @throws InformationNonConforme
      */

src/recepteurs/RecepteurAnalogiqueMulti.java

@@ -4,7 +4,7 @@
 import information.InformationNonConforme;
 
 /**
- * Classe d'un composant recepteur d'informations dont les élèments sont de type
+ * Classe d'un composant recepteur d'informations dont les éléments sont de type
  * Double qui hérite de la classe Recepteur
  *
  * @author Antoine GIRARD
@@ -30,14 +30,14 @@ public Double[] getAr() {
      * Constructeur du récepteur analogique
      *
      * @param form Forme du signal à recevoir
-     * @param nbEch Nombre d'écahntillon par symbole
+     * @param nbEch Nombre d'échantillons par symbole
      * @param amplMin Amplitude pour la valeur binaire 0
      * @param amplMax Amplitude pour la valeur binaire 1
      * @param dutyCycleRZ Dutycycle à utiliser dans le cadre d'une forme RZ
      * @param tmpMontee Temps de montée à respecté dans le cadre d'une forme
      * NRZT
-     * @param dt Tableau de décalage des multitrajet
-     * @param ar Tableau d'atténuation des multitrajet
+     * @param dt Tableau de décalage des multitrajets
+     * @param ar Tableau d'atténuation des multitrajets
      */
     public RecepteurAnalogiqueMulti(String form, int nbEch, double amplMin, double amplMax, double dutyCycleRZ, double tmpMontee, Integer[] dt, Double[] ar) {
         super(form, nbEch, amplMin, amplMax, dutyCycleRZ, tmpMontee);
@@ -49,14 +49,14 @@ public RecepteurAnalogiqueMulti(String form, int nbEch, double amplMin, double a
      * Constructeur du récepteur analogique
      *
      * @param form Forme du signal à recevoir
-     * @param nbEch Nombre d'écahntillon par symbole
+     * @param nbEch Nombre d'échantillons par symbole
      * @param amplMin Amplitude pour la valeur binaire 0
      * @param amplMax Amplitude pour la valeur binaire 1
      * @param dutyCycleRZ Dutycycle à utiliser dans le cadre d'une forme RZ
-     * @param tmpMontee Temps de montée à respecté dans le cadre d'une forme
+     * @param tmpMontee Temps de montée à respecter dans le cadre d'une forme
      * NRZT
-     * @param dt Tableau de décalage des multitrajet
-     * @param ar Tableau d'atténuation des multitrajet
+     * @param dt Tableau de décalage des multitrajets
+     * @param ar Tableau d'atténuation des multitrajets
      * @param noMultiCorrection
      */
     public RecepteurAnalogiqueMulti(String form, int nbEch, double amplMin, double amplMax, double dutyCycleRZ, double tmpMontee, Integer[] dt, Double[] ar, boolean noMultiCorrection) {
@@ -95,7 +95,7 @@ protected Information<Double> stripEch(Information<Double> infRecue) throws Info
     }
 
     /**
-     * Enlève les trajets multiples des échantillons //TODO ajouter des solution
+     * Enlève les trajets multiples des échantillons //TODO ajouter des solutions
      * pour limiter les différents bruits
      *
      * @param infRecue L'information à nettoyer

src/recepteurs/RecepteurAnalogiqueMultiIntelligent.java

@@ -10,7 +10,7 @@
 import tools.Statistic;
 
 /**
- * Classe d'un composant recepteur d'informations dont les élèments sont de type
+ * Classe d'un composant recepteur d'informations dont les éléments sont de type
  * Double qui hérite de la classe Recepteur
  *
  * @author Antoine GIRARD

src/sources/SourceAleatoire.java

@@ -4,7 +4,7 @@
 import java.util.Random;
 
 /**
- * Classe d'un composant source d'informations aléatoire dont les élèments sont de type Boolean
+ * Classe d'un composant source d'informations aléatoires dont les éléments sont de type Boolean
  * @author Antoine GIRARD
  * @author Cédric HERZOG
  */
@@ -20,7 +20,7 @@ public SourceAleatoire(int nbBits) {
 
     /**
     * Un constructeur qui génère nbBits aléatoirement basé sur un seed
-     * @param nbBits nombre de bit à générer
+     * @param nbBits nombre de bits à générer
      * @param seed graine utilisé comme base pour le message pseudo-aléatoire
     */
     public SourceAleatoire(int nbBits, int seed) {

src/sources/SourceBruitGaussien.java

@@ -21,7 +21,7 @@ public class SourceBruitGaussien extends Source<Double> {
     /**
      * Un constructeur qui génère nbEch aléatoirement
      *
-     * @param nbEch nombre de bit à générer
+     * @param nbEch nombre de bits à générer
      */
     public SourceBruitGaussien(int nbEch) {
         this(nbEch, 1f, (int) (Math.random() * 1024));
@@ -30,7 +30,7 @@ public SourceBruitGaussien(int nbEch) {
     /**
      * Un constructeur qui génère nbEch aléatoirement
      *
-     * @param nbEch nombre de bit à générer
+     * @param nbEch nombre de bits à générer
      * @param puissance puissance du bruit
      */
     public SourceBruitGaussien(int nbEch, double puissance) {
@@ -40,7 +40,7 @@ public SourceBruitGaussien(int nbEch, double puissance) {
     /**
      * Un constructeur qui génère nbEch aléatoirement rapidement
      *
-     * @param nbEch Nombre de bit à générer
+     * @param nbEch Nombre de bits à générer
      * @param puissance Puissance du signal
      * @param seed le grain de génération
      * @param quick Utiliser un mode rapide mais moins proche de la réalité
@@ -66,7 +66,7 @@ public SourceBruitGaussien(int nbEch, double puissance, final int seed, boolean
     /**
      * Un constructeur qui génère nbEch aléatoirement
      *
-     * @param nbEch Nombre de bit à générer
+     * @param nbEch Nombre de bits à générer
      * @param puissance Puissance du signal
      * @param seed le grain de génération
      *

src/sources/SourceFixe.java

@@ -3,7 +3,7 @@
 import information.Information;
 
 /**
- * Classe d'un composant source d'informations fixé dont les élèments sont de
+ * Classe d'un composant source d'informations fixées dont les éléments sont de
  * type Boolean
  *
  * @author Antoine GIRARD
@@ -12,7 +12,7 @@
 public class SourceFixe extends Source<Boolean> {
 
     /**
-    * Un constructeur qui génère les bits basé sur messageSimulateur
+    * Un constructeur qui génère les bits basés sur messageSimulateur
      * @param messageSimulateur le message qui fixe les bits */
     public SourceFixe(String messageSimulateur) {
         super();