[mareframe] Annotation of /trunk/gadget/rectangle.h
Annotation of /trunk/gadget/rectangle.h
Parent Directory
| Revision Log
Revision 1 -
(view)
(download)
1 : |
agomez |
1 |
#ifndef rectangle_h
|
2 : |
|
|
#define rectangle_h
|
3 : |
|
|
|
4 : |
|
|
#include "gadget.h" |
5 : |
|
|
#include "commentstream.h" |
6 : |
|
|
|
7 : |
|
|
/**
|
8 : |
|
|
* \class Rectangle
|
9 : |
|
|
* \brief This is the class used to store the co-ordinates and size of an area, used when calculating the migration within the model
|
10 : |
|
|
*/
|
11 : |
|
|
class Rectangle {
|
12 : |
|
|
public:
|
13 : |
|
|
/**
|
14 : |
|
|
* \brief This is the default Rectangle constructor
|
15 : |
|
|
*/
|
16 : |
|
|
Rectangle();
|
17 : |
|
|
/**
|
18 : |
|
|
* \brief This is the Rectangle constructor
|
19 : |
|
|
* \param infile is the CommentStream to read the rectangle parameters from
|
20 : |
|
|
*/
|
21 : |
|
|
Rectangle(CommentStream& infile);
|
22 : |
|
|
/**
|
23 : |
|
|
* \brief This is the default Rectangle destructor
|
24 : |
|
|
*/
|
25 : |
|
|
~Rectangle() {};
|
26 : |
|
|
/**
|
27 : |
|
|
* \brief This will return the lower co-ordinate for the x axis of the rectangle
|
28 : |
|
|
* \return xLower
|
29 : |
|
|
*/
|
30 : |
|
|
double getLowerX() { return xLower; };
|
31 : |
|
|
/**
|
32 : |
|
|
* \brief This will return the lower co-ordinate for the y axis of the rectangle
|
33 : |
|
|
* \return yLower
|
34 : |
|
|
*/
|
35 : |
|
|
double getLowerY() { return yLower; };
|
36 : |
|
|
/**
|
37 : |
|
|
* \brief This will return the upper co-ordinate for the x axis of the rectangle
|
38 : |
|
|
* \return xUpper
|
39 : |
|
|
*/
|
40 : |
|
|
double getUpperX() { return xUpper; };
|
41 : |
|
|
/**
|
42 : |
|
|
* \brief This will return the upper co-ordinate for the y axis of the rectangle
|
43 : |
|
|
* \return yUpper
|
44 : |
|
|
*/
|
45 : |
|
|
double getUpperY() { return yUpper; };
|
46 : |
|
|
/**
|
47 : |
|
|
* \brief This will return the size of the rectangle
|
48 : |
|
|
* \return areaSize
|
49 : |
|
|
*/
|
50 : |
|
|
double getArea() { return areaSize; };
|
51 : |
|
|
private:
|
52 : |
|
|
/**
|
53 : |
|
|
* \brief This is the lower co-ordinate for the x axis of the rectangle
|
54 : |
|
|
*/
|
55 : |
|
|
double xLower;
|
56 : |
|
|
/**
|
57 : |
|
|
* \brief This is the lower co-ordinate for the y axis of the rectangle
|
58 : |
|
|
*/
|
59 : |
|
|
double yLower;
|
60 : |
|
|
/**
|
61 : |
|
|
* \brief This is the upper co-ordinate for the x axis of the rectangle
|
62 : |
|
|
*/
|
63 : |
|
|
double xUpper;
|
64 : |
|
|
/**
|
65 : |
|
|
* \brief This is the upper co-ordinate for the y axis of the rectangle
|
66 : |
|
|
*/
|
67 : |
|
|
double yUpper;
|
68 : |
|
|
/**
|
69 : |
|
|
* \brief This is the calculated size of the area of the rectangle
|
70 : |
|
|
*/
|
71 : |
|
|
double areaSize;
|
72 : |
|
|
};
|
73 : |
|
|
|
74 : |
|
|
#endif
|
|