Verified Commit 59d47d72 authored by Romain De Laage De Bellefaye's avatar Romain De Laage De Bellefaye 🌳
Browse files

Improve autosql doc

parent e2fc824b
Pipeline #79793 passed with stage
in 16 seconds
...@@ -35,26 +35,41 @@ class Database { ...@@ -35,26 +35,41 @@ class Database {
/// Obtenir la liste de tous les noms d'automate disponibles /// Obtenir la liste de tous les noms d'automate disponibles
std::vector<QString> getAutomates() const; std::vector<QString> getAutomates() const;
/// Obtenir la fonction d'un automate donné /// Obtenir la fonction d'un automate donné
/// @param[in] a Automate dont on souhaite obtenir la Fonction
Fonction* getFonction(Automate& a) const; Fonction* getFonction(Automate& a) const;
/// Obtenir la règle de voisinage d'un automate par son nom /// Obtenir la règle de voisinage d'un automate par son nom
/// @param[in] name nom de l'Automate dont on souhaite la RegleVoisinage
RegleVoisinage* getRegleVoisinage(const QString& name) const; RegleVoisinage* getRegleVoisinage(const QString& name) const;
/// Obtenir la liste des grilles disponibles pour un automate par son nom /// Obtenir la liste des Reseau disponibles pour un Automate par son nom
/// @param[in] name nom de l'Automate
std::vector<QString> getListeReseaux(const QString& name) const; std::vector<QString> getListeReseaux(const QString& name) const;
/// Obtenir un réseau par son nom /// Obtenir un réseau par son nom
/// @param[in] idReseau identifiant du Reseau dans la base de donnée
Reseau& getReseau(int idReseau) const; Reseau& getReseau(int idReseau) const;
/// Sauvegarder un réseau en base de donnée /// Sauvegarder un réseau en base de donnée
/// @param[in] reseau Reseau à sauvegarder
/// @param[in] nomReseau nom du Reseau à sauvegarder
/// @param[in] nomAutomate nom de l'Automate à qui il appartient
void stockerReseau(const Reseau& reseau, const QString& nomReseau, const QString& nomAutomate) const; void stockerReseau(const Reseau& reseau, const QString& nomReseau, const QString& nomAutomate) const;
/// Initialise l'ensemble d'état d'un automate /// Initialise l'ensemble d'état d'un automate
/// @param[in] a Automate dont on souhaite initialiser l'EnsembleEtat
void initEnsEtat(Automate& a) const; void initEnsEtat(Automate& a) const;
/// Sauvegarder un automate en BDD /// Sauvegarder un automate en BDD
/// @param[in] a Automate que l'on souhaite sauvegarder
void saveAutomaton(const Automate& a) const; void saveAutomaton(const Automate& a) const;
/// Sauvegarder une fonction en BDD /// Sauvegarder une fonction en BDD
/// @param[in] name nom de l'Automate à qui appartien la Fonction
/// @param[in] f Fonction à sauvegarder
void saveFunction(const QString& name, const Fonction& f) const; void saveFunction(const QString& name, const Fonction& f) const;
/// Sauvegarder une règle de voisinage en BDD /// Sauvegarder une règle de voisinage en BDD
/// @param[in] name nom de l'Automate à qui appartien la RegleVoisinage
/// @param[in] r RegleVoisinage à sauvegarder
void saveVoisinage(const QString& name, const RegleVoisinage& r) const; void saveVoisinage(const QString& name, const RegleVoisinage& r) const;
/// Sauvegarder un ensemble d'états en BDD /// Sauvegarder un ensemble d'états en BDD
/// @param[in] a Automate dont on souhaite sauvegarder l'ensemble
void saveEnsemble(Automate& a) const; void saveEnsemble(Automate& a) const;
/// initialiser le singleton automate depuis la bdd par son nom /// initialiser le singleton automate depuis la bdd par son nom
/// @param[in] modele nom du modèle que l'on souhaite initialiser
void initSingletonAutomate(const QString& modele) const; void initSingletonAutomate(const QString& modele) const;
}; };
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment