BaitLocation Class Reference

Class used for describing the rodenticide bait location. More...

#include <Rodenticide.h>

Public Member Functions
	BaitLocation (int a_x, int a_y, TTypesBaitLocation a_type)
	BaitLocation constructor. More...
virtual	~BaitLocation (void)
	BaitLocation destructor. More...
int	GetX (void)
	Get x-coordinate. More...
int	GetY (void)
	Get y-coordinate. More...
int	GetMass (void)
	Get bait mass. More...
int	GetstartDay (void)
	Get start day. More...
TTypesBaitLocation	GetBLtype (void)
	Get bait location type. More...
bool	GetUseFlag ()
	Get use flag. More...
void	SetX (int a_x)
	Set x-coordinate. More...
void	SetY (int a_y)
	Set y-coordinate. More...
void	SetstartDay (int a_startDay)
	Set start day. More...
void	SetMass (int a_mass)
	Set bait mass. More...
void	ReduceMass (int a_mass)
	Set bait mass. More...
void	SetBLtype (TTypesBaitLocation a_BLt)
	Set bait location type. More...
void	Reset ()
	Reset all flags and mass. More...
void	SetUseFlag (bool a_flag)
	Set use flag. More...

Protected Attributes
int	m_x
	x-coordinate More...
int	m_y
	y-coordinate More...
int	m_mass
	bait mass More...
TTypesBaitLocation	m_BLtype
	bait replenishment frequency More...
bool	m_useThisYear
	flag for bait location use this year More...
int	m_startDay
	date for placement of first bait More...

Detailed Description

Class used for describing the rodenticide bait location.

Constructor & Destructor Documentation

BaitLocation()

BaitLocation::BaitLocation	(	int	a_x,
		int	a_y,
		TTypesBaitLocation	a_type
	)

BaitLocation constructor.

{
    SetX(a_x);
    SetY(a_y);
    SetBLtype(a_type);
    Reset();
}

~BaitLocation()

BaitLocation::~BaitLocation ( void  )

virtual

BaitLocation destructor.

{
    ;
}

Member Function Documentation

GetBLtype()

TTypesBaitLocation BaitLocation::GetBLtype ( void  )

inline

Get bait location type.

{ return m_BLtype; }

GetMass()

int BaitLocation::GetMass ( void  )

inline

Get bait mass.

{ return m_mass; }

GetstartDay()

int BaitLocation::GetstartDay ( void  )

inline

Get start day.

{ return m_startDay; }

GetUseFlag()

bool BaitLocation::GetUseFlag ( )

inline

Get use flag.

{ return m_useThisYear; }

GetX()

int BaitLocation::GetX ( void  )

inline

Get x-coordinate.

{ return m_x; }

GetY()

int BaitLocation::GetY ( void  )

inline

Get y-coordinate.

{ return m_y; }

ReduceMass()

void BaitLocation::ReduceMass ( int  a_mass )

inline

Set bait mass.

{ m_mass -= a_mass; }

Reset()

void BaitLocation::Reset ( )

inline

Reset all flags and mass.

{ m_mass = 0; m_useThisYear = false; m_startDay=-1;}

SetBLtype()

void BaitLocation::SetBLtype ( TTypesBaitLocation  a_BLt )

inline

Set bait location type.

{ m_BLtype = a_BLt; }

Referenced by RodenticideManager::RodenticideManager().

SetMass()

void BaitLocation::SetMass ( int  a_mass )

inline

Set bait mass.

{ m_mass = a_mass; }

SetstartDay()

void BaitLocation::SetstartDay ( int  a_startDay )

inline

Set start day.

{ m_startDay = a_startDay; }

SetUseFlag()

void BaitLocation::SetUseFlag ( bool  a_flag )

inline

Set use flag.

{ m_useThisYear = a_flag; }

SetX()

void BaitLocation::SetX ( int  a_x )

inline

Set x-coordinate.

{ m_x = a_x; }

Referenced by RodenticideManager::RodenticideManager().

SetY()

void BaitLocation::SetY ( int  a_y )

inline

Set y-coordinate.

{ m_y = a_y; }

Referenced by RodenticideManager::RodenticideManager().

Member Data Documentation

m_BLtype

TTypesBaitLocation BaitLocation::m_BLtype

protected

bait replenishment frequency

m_mass

int BaitLocation::m_mass

protected

bait mass

m_startDay

int BaitLocation::m_startDay

protected

date for placement of first bait

m_useThisYear

bool BaitLocation::m_useThisYear

protected

flag for bait location use this year

m_x

int BaitLocation::m_x

protected

x-coordinate

This class has no functionality apart from get/set and arithmetic manipulation of class members.

m_y

int BaitLocation::m_y

protected

y-coordinate

---

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

• C:/Repo/ALMaSS_all/RodenticideModelling/Rodenticide.h
• C:/Repo/ALMaSS_all/RodenticideModelling/Rodenticide.cpp