Aiming Wu / Mbed 2 deprecated 2645_Assignment

Doxyjen of the Bird.h

Dependencies:   mbed N5110

Begin/Begin.h@6:0912dfea40f5, 2019-05-05 (annotated)

Committer:
Wuuu
Date:
Sun May 05 17:46:26 2019 +0000
Revision:
6:0912dfea40f5
Parent:
5:abe12cabd0b7 
Final Submission. I have read and agreed with Statement of Academic Integrity.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wuuu 0:0aea7b9ba421 1 #ifndef BEGIN_H
Wuuu 0:0aea7b9ba421 2 #define BEGIN_H
Wuuu 0:0aea7b9ba421 3
Wuuu 0:0aea7b9ba421 4 #include "mbed.h"
Wuuu 0:0aea7b9ba421 5 #include "N5110.h"
Wuuu 0:0aea7b9ba421 6 #include "Gamepad.h"
Wuuu 0:0aea7b9ba421 7 #include "Wall1.h"
Wuuu 0:0aea7b9ba421 8 #include "Bird.h"
Wuuu 0:0aea7b9ba421 9
Wuuu 5:abe12cabd0b7 10 /** Begin class
Wuuu 5:abe12cabd0b7 11
Wuuu 5:abe12cabd0b7 12 *@brief Library to combine the Bird and the Wall1
Wuuu 6:0912dfea40f5 13 *@author Wu Aiming
Wuuu 6:0912dfea40f5 14 *@date May 2019
Wuuu 5:abe12cabd0b7 15 */
Wuuu 5:abe12cabd0b7 16
Wuuu 0:0aea7b9ba421 17 class Begin
Wuuu 0:0aea7b9ba421 18 {
Wuuu 0:0aea7b9ba421 19 public:
Wuuu 5:abe12cabd0b7 20
Wuuu 5:abe12cabd0b7 21 /**Constructor*/
Wuuu 0:0aea7b9ba421 22 Begin();
Wuuu 5:abe12cabd0b7 23 /**Destructor*/
Wuuu 0:0aea7b9ba421 24 ~Begin();
Wuuu 5:abe12cabd0b7 25 /**
Wuuu 5:abe12cabd0b7 26 *@brief Initialise all parameters of the Begin
Wuuu 5:abe12cabd0b7 27 */
Wuuu 0:0aea7b9ba421 28 void init();
Wuuu 5:abe12cabd0b7 29 /**
Wuuu 5:abe12cabd0b7 30 *@brief Draw the bird, wall1 and live scores
Wuuu 5:abe12cabd0b7 31 *@param lcd, pad
Wuuu 5:abe12cabd0b7 32 *@returns The number to test whether the bird crash the wall1
Wuuu 5:abe12cabd0b7 33 *@details Use the method to use function within N5110.h and Gamepad.h file
Wuuu 5:abe12cabd0b7 34 */
Wuuu 0:0aea7b9ba421 35 int draw(N5110 &lcd, Gamepad &pad);
Wuuu 5:abe12cabd0b7 36 /**
Wuuu 5:abe12cabd0b7 37 *@brief Get the live score
Wuuu 5:abe12cabd0b7 38 *@param lcd
Wuuu 5:abe12cabd0b7 39 *@return The live score
Wuuu 5:abe12cabd0b7 40 */
Wuuu 0:0aea7b9ba421 41 int get_score(N5110 &lcd);
Wuuu 0:0aea7b9ba421 42
Wuuu 0:0aea7b9ba421 43 private:
Wuuu 0:0aea7b9ba421 44
Wuuu 0:0aea7b9ba421 45 int _m;
Wuuu 0:0aea7b9ba421 46 int _s;
Wuuu 0:0aea7b9ba421 47 int _a1;
Wuuu 0:0aea7b9ba421 48 int _b1;
Wuuu 0:0aea7b9ba421 49 int _a2;
Wuuu 0:0aea7b9ba421 50 int _b2;
Wuuu 0:0aea7b9ba421 51 int _a3;
Wuuu 0:0aea7b9ba421 52 int _b3;
Wuuu 0:0aea7b9ba421 53 int _h;
Wuuu 0:0aea7b9ba421 54 Bird _Bird;
Wuuu 0:0aea7b9ba421 55 Wall1 _Wall1;
Wuuu 0:0aea7b9ba421 56 };
Wuuu 0:0aea7b9ba421 57
Wuuu 0:0aea7b9ba421 58 #endif
Wuuu 0:0aea7b9ba421 59
Wuuu 6:0912dfea40f5 60