Diff: Operator.h

Revision:

7:5d9b9d0bc6e7

Parent:

6:9882809b0694

Child:

8:93f18f1c1241

diff -r 9882809b0694 -r 5d9b9d0bc6e7 Operator.h
--- a/Operator.h	Sun Apr 16 13:45:15 2017 +0000
+++ b/Operator.h	Sun Apr 16 19:37:55 2017 +0000
@@ -9,21 +9,33 @@
 class Operator
 {
 
-public:
+public: 
+    
+    /**Contructor*/
     Operator();
+    
+    /**Destructor*/
     ~Operator();
 
 
-    void check(N5110 &lcd);  
-    int random_instruction(Display &display, N5110 &lcd);
-    void init(); 
-    void Correct(Controller &pad); 
-    void Game_Over(Controller &pad, N5110 &lcd);
-    int score;
+ /**
+     * @brief generates a random interger to be used in the display class to represent an instruction
+     * @return void random interger
+     */
+    int random_instruction(Display &display, N5110 &lcd);  
+
+/** Methord performed when the user performs the right instruction on time, score is increased, lighting and sound performed.*/
+    void Correct(Controller &ctrl);  
     
-private:
-    void update(Controller &pad);   
-    void Assessment(N5110 &lcd, int score);
+/** Methord performed when the user is too slow or performs the wrong instruction, score is displayed, game ends */
+    void Game_Over(Controller &ctrl, N5110 &lcd);
+    
+private:  
+    /** This methord displays and assesses score and display a performace rating for user to see.*/
+    void Assessment(N5110 &lcd, int score); 
+    
+    float freq_change;
+    int score; // <score to indentify users progress through game
     
     
 };