Unverified Commit d1623008 authored by Merwane Bouri's avatar Merwane Bouri
Browse files

Documentation de History

parent 6e85a081
Pipeline #78300 passed with stages
in 16 seconds
......@@ -27,22 +27,42 @@ public:
return _msg.c_str();
}
};
/**
\struct History
\brief Représente l'historique des grilles.
Cette structure représente l'historique des grilles.
**/
class History{
unsigned int nbMax;
std::deque<Grid> tab;
public:
//! \brief Constructeur par défaut, génère un historique capable de stocker un nombre max de grilles.
History(unsigned int nbM);
//! \brief Accesseur sur le nombre max
//! \return Retourne le nombre de lignes de la Grille
unsigned int get_nbMax()const{return nbMax;}
//! \brief Ajoute une grille dans l'historique
void pushGrid(const Grid& g);
//! \brief Fonction qui retire la dernière grille de l'historique, et la renvoie
//! \return Retourne la dernière grille ajoutée de l'historique
Grid popGrid();
//! \brief Fonction qui retourne la dernière grille sans la retirer
//! \return Retourne la dernière grille ajoutée de l'historique
Grid topGrid()
{
if(tab.size()>0)
return tab.back();
throw HistoryException("La pile est vide. \n");
}
//! \brief Fonction qui vérifie si l'historique est vide ou pas
//! \return Retourne un booléen selon si le prédicat "l'historique est vide"
bool isEmpty()
{
return tab.empty();
......
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