Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 3.02 KB

README.md

File metadata and controls

57 lines (44 loc) · 3.02 KB
Raw

Astuce-API

API pour le réseau Astuce, réseau de transports en commun de la Métropole Rouen Normandie.

Installation

Ajouter le fichier jar à votre projet en tant que bibliothèque liée.

Eclipse :

Clic-droit sur le projet => Properties => Java Build Path => Libraries => Add External JARs => Choisir le .jar de l'API


Usage

Javadoc disponible ici : https://alba0404.github.io/Astuce-API/

import fr.alba0404.astuce.api.*;

Astuce_API api = new Astuce_API();
int next = api.getNext(Line.METRO, Station.VOLTAIRE, 2);  // Retourne le temps en minute avant le prochain transport
                                                          // sur la ligne de métro à l'arrêt Voltaire en direction de Boulingrin (2).
                                                          // peut lever l'exception StationNotOnLineException si la station indiquée
                                                          // ne se trouve pas sur la ligne.

List<Station> stations = api.getStations(Line.METRO);  // Retourne une liste des stations se trouvant sur la ligne de métro.

Station.values();                 // Retourne un tableau de toutes les stations.
Station s = Station.BOULINGRIN;   // Récupère la station Boulingrin.
List<Line> lines = s.getLines();  // Retourne une liste des lignes passant par cette station.
String name = s.getName();        // Retourne le nom de la station tel qu'utilisé par le réseau Astuce.
int id = s.getId();               // Retourne un entier représentant l'id unique de la station sur le réseau.

Line.values();                           // Retourne un tableau de toutes les lignes.
Line line = Line.getLineByName("Métro"); // Retourne la station dont le nom est "Métro".
Line line = Lien.getLineById(175);       // Retourne la ligne ayant l'id 175. 

Line line = Line.METRO;                  // Récupère la ligne de métro.
String name = line.getName();            // Retourne le nom de la ligne.
int id = line.getId();                   // Retourne l'id de la ligne.
String[] terminus = line.getTerminus();  // Retourne un tableau des terminus.
String t = line.getTerminus(1);          // Retourne le terminus n°1.

En cours... / In dev...

  • Finalisation de l'ajout des lignes et stations
  • Ajouter les lignes scolaires.

Licence / License

Le terme programme représente le fichier .jar ainsi que ses sources, fichiers binaires et ressources attachées.

  • Ce programme est distribué sans aucune garantie.
  • Ce programme est la propriété intellectuelle de son développeur : Alba0404.
  • Il est autorisé de télécharger et exécuter ce programme à des fins commerciales ou non du moment que celles-ci sont légales.
  • Il est autorisé de faire de la rétro-ingéniérie.
  • Il est interdit de vendre ce programme sous une quelconque forme, modifié ou non.
  • Si le programme est utilisé dans un projet, quelque soit la forme de celui-ci, la citation du développeur est obligatoire. De plus ce projet doit respecter les lois en vigueurs.