Diff: Tests/tests.h

Revision:

26:35714debc45f

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Tests/tests.h	Sat Apr 20 21:23:33 2019 +0000
@@ -0,0 +1,101 @@
+#ifndef TESTS_H
+#define TESTS_H
+#include "RocketRacer.h"
+#include "Menus.h"
+ 
+ 
+ /** Menus class
+
+@brief C++ class containing the tests for methods
+
+@version 1.0
+
+@author Omar Alebiary
+
+@date April 2019
+
+@code
+
+#include "mbed.h"
+#include "N5110.h"
+#include "Gamepad.h"
+#include "RocketRacer.h"
+
+// objects 
+Gamepad pad;
+RocketRacer rc;
+Menus menus;
+tests test;
+
+
+
+int main(){
+    
+    
+     setup();
+     test.test_welcomeMenu(pad,lcd);
+     test.test_PlayMelody(pad);
+     test.test_drawMenu(lcd, pad);
+     test.test_credits_page(lcd,pad);
+     test.test_loading_menu(lcd);
+     test.test_InstructionsMenu(pad,lcd);
+     test.test_Game_Loop(pad,lcd);
+    
+    
+    
+    
+
+}
+
+@endcode
+*/
+  
+  
+class tests{
+    
+    public:
+    
+    /**
+  * @brief method to test welcome menu
+  * @param pad @details calls the Gamepad object to be passed to the methods called inside this method
+  * @param lcd @details calls the lcd object to be passed to the methods called inside this method
+  */
+  void test_welcomeMenu(Gamepad &pad,N5110 &lcd);
+  /**
+  * @brief method to test tones played in the game
+  * @param pad @details calls the Gamepad object to be passed to the methods called inside this method
+  */ 
+  void test_PlayMelody(Gamepad &pad);
+  /**
+  * @brief method to test  the draw main menu method
+  * @param pad @details calls the Gamepad object to be passed to the methods called inside this method
+  * @param lcd @details calls the lcd object to be passed to the methods called inside this method
+  */ 
+  void test_drawMenu(N5110 &lcd,Gamepad &pad);
+  /**
+  * @brief method to test  the credits page on the menu
+  * @param pad @details calls the Gamepad object to be passed to the methods called inside this method
+  * @param lcd @details calls the lcd object to be passed to the methods called inside this method
+  */ 
+  void test_credits_page(N5110 &lcd,Gamepad &pad);
+  /**
+  * @brief method to test  the loading page
+  * @param lcd @details calls the lcd object to be passed to the methods called inside this method
+  */ 
+  void test_loading_menu(N5110 &lcd);
+  /**
+  * @brief method to test  the instructions page
+  * @param lcd @details calls the lcd object to be passed to the methods called inside this method
+  * @param pad @details calls the Gamepad object to be passed to the methods called inside this method
+  */ 
+  void test_InstructionsMenu(Gamepad &pad,N5110 &lcd);
+  /**
+  * @brief method to test  the game loop which has all the game methods calls in it 
+  * @param lcd @details calls the lcd object to be passed to the methods called inside this method
+  * @param pad @details calls the Gamepad object to be passed to the methods called inside this method
+  */
+  void test_Game_Loop(Gamepad &pad,N5110 &lcd);
+  
+};
+
+#endif
\ No newline at end of file