Rectangle Class Reference

This is the class used to store the co-ordinates and size of an area, used when calculating the migration within the model. More...

#include <rectangle.h>

Collaboration diagram for Rectangle:

Public Member Functions
	Rectangle ()
	This is the default Rectangle constructor. More...
	Rectangle (CommentStream &infile)
	This is the Rectangle constructor. More...
	~Rectangle ()
	This is the default Rectangle destructor. More...
double	getLowerX ()
	This will return the lower co-ordinate for the x axis of the rectangle. More...
double	getLowerY ()
	This will return the lower co-ordinate for the y axis of the rectangle. More...
double	getUpperX ()
	This will return the upper co-ordinate for the x axis of the rectangle. More...
double	getUpperY ()
	This will return the upper co-ordinate for the y axis of the rectangle. More...
double	getArea ()
	This will return the size of the rectangle. More...

Detailed Description

This is the class used to store the co-ordinates and size of an area, used when calculating the migration within the model.

Constructor & Destructor Documentation

Rectangle() [1/2]

Rectangle::Rectangle

(

)

This is the default Rectangle constructor.

Rectangle() [2/2]

Rectangle::Rectangle

(

CommentStream &

infile

)

This is the Rectangle constructor.

Parameters

infile

is the CommentStream to read the rectangle parameters from

~Rectangle()

Rectangle::~Rectangle ( )

inline

This is the default Rectangle destructor.

Member Function Documentation

getArea()

double Rectangle::getArea ( )

inline

This will return the size of the rectangle.

Returns

areaSize

getLowerX()

double Rectangle::getLowerX ( )

inline

This will return the lower co-ordinate for the x axis of the rectangle.

Returns

xLower

getLowerY()

double Rectangle::getLowerY ( )

inline

This will return the lower co-ordinate for the y axis of the rectangle.

Returns

yLower

getUpperX()

double Rectangle::getUpperX ( )

inline

This will return the upper co-ordinate for the x axis of the rectangle.

Returns

xUpper

getUpperY()

double Rectangle::getUpperY ( )

inline

This will return the upper co-ordinate for the y axis of the rectangle.

Returns

yUpper

---

The documentation for this class was generated from the following files:

• src/include/rectangle.h
• src/rectangle.cc