LivesOnAreas Class Reference

This is the class used to store information about the areas an object is defined on for the current model. More...

#include <livesonareas.h>

Inheritance diagram for LivesOnAreas:

Collaboration diagram for LivesOnAreas:

Public Member Functions
	LivesOnAreas ()
	This is the default LivesOnAreas constructor. More...
virtual	~LivesOnAreas ()
	This is the default LivesOnAreas destructor. More...
	LivesOnAreas (const IntVector &Areas)
	This is the LivesOnAreas constructor for a specified vector of areas. More...
int	isInArea (int area) const
	This function will check whether the object is defined on a specified area. More...
IntVector &	getAreas ()
	This function will return the internal areas that the object is defined on. More...
int	areaNum (int area) const
	This function will return the area associated with an internal area. More...

Protected Member Functions
void	storeAreas (const IntVector &Areas)
	This function will store the internal areas to be used. More...

Protected Attributes
IntVector	areas
	This is the IntVector of internal areas that the object is defined on. More...

Detailed Description

This is the class used to store information about the areas an object is defined on for the current model.

Constructor & Destructor Documentation

LivesOnAreas() [1/2]

LivesOnAreas::LivesOnAreas ( )

inline

This is the default LivesOnAreas constructor.

~LivesOnAreas()

virtual LivesOnAreas::~LivesOnAreas ( )

inlinevirtual

This is the default LivesOnAreas destructor.

LivesOnAreas() [2/2]

LivesOnAreas::LivesOnAreas

(

const IntVector &

Areas

)

This is the LivesOnAreas constructor for a specified vector of areas.

Parameters

Areas

is the IntVector of internal areas to be used

Member Function Documentation

areaNum()

int LivesOnAreas::areaNum

(

int

area

)

const

This function will return the area associated with an internal area.

Parameters

area	is an integer to denote the internal area of interest

Returns

the associated area number

getAreas()

IntVector& LivesOnAreas::getAreas ( )

inline

This function will return the internal areas that the object is defined on.

Returns

areas

isInArea()

int LivesOnAreas::isInArea

(

int

area

)

const

This function will check whether the object is defined on a specified area.

Parameters

area	is an integer to denote the internal area of interest

Returns

1 if the object is defined on the area, 0 otherwise

storeAreas()

void LivesOnAreas::storeAreas ( const IntVector &  Areas )

protected

This function will store the internal areas to be used.

Parameters

Areas

is the IntVector of internal areas to be used

Member Data Documentation

areas

IntVector LivesOnAreas::areas

protected

This is the IntVector of internal areas that the object is defined on.

---

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

• src/include/livesonareas.h
• src/livesonareas.cc