Guide de l'utilisateur

Transcription

1 Guide de l'utilisateur Plan : 1/ Présentation des fonctionnalités de l'application 1.1/ Barre de menu 1.2/ Les boutons 2/ Ouverture de fichier 2.1/ Ouverture de fichier.xml 2.2/ Ouverture de fichier.serial 3/ Création d'un automate 3.1/ Création/Édition des états 3.1.1/ Création 3.1.2/ Edition 3.2/ Création/Édition des transitions 3.2.1/ Création 3.2.2/ Édition 3.3/ Déplacement d'un objet 3.4/ Choix des algorithmes de placement 4/ Affichage d'un automate 5/ Sauvegarde 5.1/ Sauvegarde XML 5.2/ Sauvegarde de fichier.serial 5.3/ Sauvegarde en image 1/ Présentation des fonctionnalités de l'application: 1.1/ Barre de menu : File : New : Permet la création d'un automate (voir création d'un automate). Open : Ouvre un fichier au format.xml ou.serial (voir ouverture de fichier). Save automaton : Sauvegarde un automate sous un fichier.serial ou.xml (voir sauvegarde). Save image : Sauvegarde l'automate en.jpg ou.eps (voir sauvegarde en image). Print automaton : Imprime une photo de l'écran. Quit : Quitte l'application. Edit :

2 Select : Permet de sélectionner un état ou une transition de l'automate et de le déplacer pour améliorer la visualisation de l'automate. Draw State : Permet de dessiner un état lors d'un clic de la souris dans le panneau de dessin. Draw transition : Permet de dessiner une transition lors d'un clic de la souris dans le panneau de dessin. Edit ports, registers and property : Ouvre une fenêtre permettant d'éditer les ports, les registres et la propriété initiale du système. View : View Draw : Permet de visualiser le panel de dessin. View Xml : Permet de visualiser le fichier xml correspondant à l'automate dessiner. View Text : Permet de visualiser sous forme textuelle l'automate dessiner. Présentation : Visualize : Color : Automaton informations : Permet de visualiser l'ensemble des informations de l'automate dans un tableau sur la droite de l'application. Les transitions sont numérotées afin de ne pas surcharger le dessin. On trouve dans le tableau récapitulatif les ports et registres utilisés ainsi que les conditions/affectations de l'automate. Transitions labels : Permet d'afficher toutes les conditions et affectations sur les transitions (surcharge l'automate lorsqu'il y a trop de transitions). Resize panel : Ouvre un fenêtre permettant de modifier la taille du dessin. Help : Il nous est apparu indispensable de permettre à l utilisateur de paramétrer ses propres couleurs. Il est donc possible de modifier : La couleur des états (cercle et nom) La couleur des transitions La couleur des labels (condition / affectation des transitions) La couleur de surbrillance. La couleur de la flèche représentant l état initial. 1.2/ Les boutons : Permet de faire afficher le guide d'utilisateur Permet de sélectionner et de déplacer un état ou une transition. Permet de créer un état.

3 Permet de créer une transition. Lance l'algorithme de placement choisit dans le menu Placement. Permet de réinitialiser la fenêtre de dessin 2/ Ouverture de fichier : 2.1/ Ouverture de fichier.xml : Pour ouvrir un fichier.xml, vous pouvez faire: File -> Open Ctrl+O et choisir votre fichier.xml 2.2/ Ouverture de fichier.serial : Pour ouvrir un fichier.serial, vous pouvez faire: soit : File -> Open soit : Ctrl+o et choisir votre fichier.serial 3/ Création d'un automate : Pour pouvoir faire fonctionner notre application, il faut au préalable définir les ports et les registres du système. Ces ports et ces registres sont indispensables à la création/édition de transitions car les conditions et les affectations doivent utiliser des variables déclarées. C est pourquoi lors de la création d un nouvelle automate, il est tout d abord demandé à l utilisateur de saisir les ports et les registres qu il utilisera par la suite pour éditer les transitions. À tout moment, l utilisateur peut modifier les ports et les registres de l automate. Par contre il n est pas demandé de définir les ports et les

4 registres lors du chargement d un automate puisque ces derniers ont déjà été définis. 3.1/ Création/Édition des états : 3.1.1/ Création : Pour créer des états il faut tout d abord se mettre en mode création d état. Pour cela il faut soit cliquer sur le bouton correspondant soit cocher la checkbox dans la barre de menu (voir bouton création état ou Edit->Draw State). L icône de la souris change ce qui confirme le mode de création d état. Passé cette étape, l utilisateur peut créer des états d un simple clic gauche de la souris. Une fenêtre s ouvre et demande à l utilisateur d entrer le nom de l état, de choisir si c est l état initial et si sa position est fixée. Si le nom de l état est valide, c est-à-dire que ce nom n est pas déjà utilisé dans l automate, alors lors de la validation l état sera ajouté à l automate sinon il sera demandé à l utilisateur de le changer 3.1.2/ Edition : Pour éditer un état (c est-à-dire changer son nom, qu il devienne l état initial ou pour fixer sa position pour les algorithmes), il faut pointer l état qui se met alors en surbrillance et faire un clic droit dessus. Un menu s ouvre et nous permet de mettre à jour ou de supprimer l état. Si on choisit de modifier l état, une fenêtre identique à celle de la création s ouvre avec les champs remplis en fonction des propriétés de l état

5 3.2/ Création/Édition des transitions : 3.2.1/ Création : Pour créer des transitions il faut tout d abord se mettre en mode création de transitions. Pour cela il faut soit cliquer sur le bouton correspondant, soit cocher la checkbox dans la barre de menu (voir bouton création transition ou Edit->Draw Transition). Comme pour la création des états l icône de la souris se modifie. L utilisateur est alors en mode de création de transitions, il doit alors cliquer sur l état de départ puis sur l état d arrivée de la transition. Une fenêtre s ouvre alors, en lui demandant de donner la condition et éventuellement les affectations nécessaires à la transition. Lorsque l utilisateur valide, on vérifie que la condition et que les affectations sont valides, c est-à-dire que les variables correspondent à un port ou à un registre de l automate, mais aussi que la syntaxe est correcte. S il n y a pas d erreurs, la transition est ajoutée, sinon on informe l utilisateur sur le champ n ayant pas réussi à passer les vérifications, et on lui laisse la possibilité de corriger son erreur / Édition : Pour éditer une transition (c est-à-dire changer sa condition ou ses affectations), il faut la pointer et faire un clic droit dessus. Un menu s ouvre et nous permet de mettre à jour ou de supprimer la transition. Si on choisit de modifier la transition, une fenêtre identique à celle de la création s ouvre avec les champs remplis 3.3/ Déplacement d un objet : Cliquer sur le bouton sélection : (screen shot) et pointé l'état ou la transition à déplacer. L'objet pointé changera de couleur, cliquer dessus en maintenant le bouton gauche de la souris enfoncé et relâcher à l'endroit voulu. 3.4/ Choix des algorithmes de placement :

6 Nous avons implémenté deux algorithmes de placement dont un très simpliste (mieux adapté lorsqu il y a peu d états) qui est l algorithme du cercle et un plus complexe (mieux adapté lorsqu il y a de nombreux états) qui est l algorithme des ressorts.lors du lancement de l application, l algorithme par défaut est celui des ressorts, mais l utilisateur peut changer d algorithme à l aide la barre de menu. En cliquant sur le bouton de placement, l automate est repositionné en utilisant l algorithme choisi. Si l'algorithme des ressorts est choisit, il est possible de déplacer et de relancer l'algorithme. Les états dont la position est fixée conserveront leur position, les autres états se positionneront en fonction des états fixes et des forces attractions/répulsions entre les états. 4/ Affichage d'un automate : Dans les automates que nous manipulons, les transitions sont étiquetées de la forme condition/affectation(s). Ces étiquettes peuvent donc être assez longues et leur affichage sur la représentation peut donc nuire à la lisibilité de l'automate. Par défaut nous n'affichons donc pas les étiquettes des transitions, mais nous avons laissé à l'utilisateur plusieurs moyens de les voir. Pointer la transition : La transition est mise en surbrillance et son label apparaît. Afficher le panel d'informations : L'utilisateur a la possibilité de faire afficher les informations relatives aux transitions, aux ports et aux registres grâce à un panel d'informations. Ce panel s'ouvre sur la droite de l'application et contient : un tableau des ports (nom, type, sens) un tableau des registre (nom, type, valeur) un tableau des transitions(identifiant, étiquette) Lorsque ce panel est ouvert, la représentation des transitions comporte en plus l'affichage de l'identifiant afin que l'utilisateur puisse facilement les retrouver dans le panel d'informations. Si une transition est pointée alors on n'affiche pas son identifiant mais son étiquette.

7 Afficher toutes les étiquettes : Cette option permet à l'utilisateur de forcer l'affichage de toutes les étiquettes. Elle est utile pour les petits automates car elle évite de faire afficher le panel d'informations qui prend de la place dans la fenêtre. L application permet de visualiser un automate à partir d un fichier xml ou d éditer un automate.lors du lancement de l'application une fenêtre apparaît : 5/ Sauvegarde : Nous avons développé un outil permettant de créer et représenter des automates formés d une centaine d'états, où l'utilisateur peut placer de façon automatique ou personnalisée. Il nous a donc fallu lui permettre de sauver et restaurer son travail, c est-à-dire mémoriser la position des éléments qui composent l automate. Pour cela nous avons prévu 2 types de sauvegarde (et de restauration) 5.1 Sauvegarde XML :

8 La sauvegarde en xml consiste simplement à écrire le contenu de l'objet Automaton en utilisant la forme Xml définie par l'application.nous obtenons donc un fichier Xml ayant la forme suivante : Vous pouvez sauvegarder de différentes façons : soit : File -> Save soit : Ctrl+o Et vous entrez le nom du fichier que vous voulez sauvegarder. 5.2/ Sauvegarde de fichier.serial : Cette sauvegarde permet de sérialiser l'objet java Automaton.Vous pouvez sauvegarder de différentes façons : soit : File -> SaveAutomaton soit : Ctrl+s Et vous entrez le nom du fichier que vous voulez sauvegarder.

9 5.3/ Sauvegarde en image : Il est possible de représenter l'automate sous forme d'image, et de mémoriser les informations relatives aux ports, aux registres et aux transitions dans un fichier texte. Lors de cette sauvegarde, nous générons un fihier.jpg qui est une photo de l'automate et un fichier.txt avec le même nom. Nous avons également prévu la sauvegarde sous forme de fichier EPS. Pour réaliser cette sauvegarde en faisant File -> SaveImage