MigrationArea Class Reference

This is the class used to store details of the areas used when calculating the migration within the model. More...

#include <migrationarea.h>

Collaboration diagram for MigrationArea:

Public Member Functions
	MigrationArea (CommentStream &infile, char *name, int id)
	This is the MigrationArea constructor. More...
	~MigrationArea ()
	This is the default MigrationArea destructor. More...
double	getArea ()
	This will return the size of the migration area. More...
int	getAreaID ()
	This will return the internal identifier of the migration area. More...
int	getNumRectangles ()
	This will return the number of rectangles that make up the the migration area. More...
RectanglePtrVector &	getRectangles ()
	This will return the RectanglePtrVector of rectangles that make up the the migration area. More...

Detailed Description

This is the class used to store details of the areas used when calculating the migration within the model.

Constructor & Destructor Documentation

MigrationArea()

MigrationArea::MigrationArea	(	CommentStream &	infile,
		char *	name,
		int	id
	)

This is the MigrationArea constructor.

Parameters

infile	is the CommentStream to read the migration area parameters from
name	is the name of the migration area
id	is the internal identifer of the migration area

~MigrationArea()

MigrationArea::~MigrationArea

(

)

This is the default MigrationArea destructor.

Member Function Documentation

getArea()

double MigrationArea::getArea ( )

inline

This will return the size of the migration area.

Returns

areaSize

getAreaID()

int MigrationArea::getAreaID ( )

inline

This will return the internal identifier of the migration area.

Returns

areaid

getNumRectangles()

int MigrationArea::getNumRectangles ( )

inline

This will return the number of rectangles that make up the the migration area.

Returns

number of rectangles

getRectangles()

RectanglePtrVector& MigrationArea::getRectangles ( )

inline

This will return the RectanglePtrVector of rectangles that make up the the migration area.

Returns

rectangles, a RectanglePtrVector of the rectangles that make up the migration area

---

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

• src/include/migrationarea.h
• src/migrationarea.cc