#include <Rabbit.h>

Inheritance diagram for Rabbit_Base:

Public Member Functions
TTypeOfRabbitState	GetCurrentRState ()

void	SetAge (int a_age)
	Set age method. More...

RabbitObjectTypes	GetRabbitType (void)
	Get rabbit type. More...

int	GetAge (void)
	Get age method. More...

void	SetweightAge (int a_age)
	Set age method. More...

int	GetweightAge (void)
	Get age method. More...

Rabbit_Warren *	GetWarren (void)
	Get warren pointer. More...

void	SetWarren (Rabbit_Warren *a_warren)
	Set the warren pointer. More...

bool	GetHasBurrow (void)
	Get burrow status. More...

void	SetHasBurrow (bool a_status)
	Set/unset burrow status. More...

void	SetDigging (int a_days)
	Set number of days to dig. More...

int	GetDigging ()
	Get number of days to dig. More...

APoint	GetBornLocation ()
	Get location of birth. More...

	Rabbit_Base (int p_x, int p_y, int p_x2, int p_y2, Landscape p_L, Rabbit_Population_Manager p_NPM, Rabbit_Warren *a_warren)
	Rabbit constructor. More...

virtual	~Rabbit_Base (void)
	Rabbit destructor. More...

virtual void	BeginStep (void)
	The BeginStep is the first 'part' of the timestep that an animal can behave in. It is called once per timestep. More...

virtual void	Step (void)
	The Step is the second 'part' of the timestep that an animal can behave in. It is called continuously until all animals report that they are 'DONE'. More...

virtual void	EndStep (void)
	The EndStep is the third 'part' of the timestep that an animal can behave in. It is called once per timestep. More...

void	OnFed (void)
	Signals food arrived today. More...

void	OnMumDead (void)
	Signals death of mum. More...

void	OnEvicted (void)
	Signals mum has a new litter to look after. More...

virtual Rabbit_Adult *	GetMate (void)
	Get mate pointer. More...

Public Member Functions inherited from TAnimal
unsigned	SupplyFarmOwnerRef ()

AnimalPosition	SupplyPosition ()

APoint	SupplyPoint ()

int	SupplyPolygonRef ()

int	Supply_m_Location_x ()

int	Supply_m_Location_y ()

virtual void	KillThis ()

virtual void	CopyMyself ()

void	SetX (int a_x)

void	SetY (int a_y)

	TAnimal (int x, int y, Landscape *L)

virtual void	ReinitialiseObject (int x, int y, Landscape *L)
	Used to re-use an object - must be implemented in descendent classes. More...

virtual int	WhatState ()

virtual void	Dying ()

void	CheckManagement (void)

void	CheckManagementXY (int x, int y)

virtual bool	OnFarmEvent (FarmToDo)

Public Member Functions inherited from TALMaSSObject
int	GetCurrentStateNo ()
	Returns the current state number. More...

void	SetCurrentStateNo (int a_num)
	Sets the current state number. More...

bool	GetStepDone ()
	Returns the step done indicator flag. More...

void	SetStepDone (bool a_bool)
	Sets the step done indicator flag. More...

virtual void	ReinitialiseObject ()
	Used to re-use an object - must be implemented in descendent classes. More...

	TALMaSSObject ()
	The constructor for TALMaSSObject. More...

virtual	~TALMaSSObject ()
	The destructor for TALMaSSObject. More...

void	OnArrayBoundsError ()
	Used for debugging only, tests basic object properties. More...

Public Attributes
RabbitObjectTypes	m_RabbitType
	The rabbits type. More...

Static Public Attributes
static double	m_dispersalmortperm = cfg_dispersalmortperm.value()
	The extra dispersal mortality per m travelled. More...

static double	m_pesticidedegradationrate = cfg_rabbit_pesticidedegradationrate.value()
	State variable used to hold the daily degredation rate of the pesticide in the body. More...

Protected Member Functions
virtual void	Explore (void)
	Exploration method. More...

virtual void	st_Dying (void)
	Default dying state. More...

bool	MortalityTest (double a_prop)
	A simple probability based test. More...

bool	WalkTo (int a_x, int a_y)
	Walks to a location from current location. More...

virtual void	InternalPesticideHandlingAndResponse ()
	Handles internal effects of pesticide exposure. If any effects are needed this method must be re-implemented by descendent classes. More...

virtual void	GeneralEndocrineDisruptor (double)
	Handles internal effects of endocrine distrupter pesticide exposure. More...

virtual void	GeneralOrganoPhosphate (double)
	Handles internal effects of organophosphate pesticide exposure. More...

Protected Member Functions inherited from TAnimal
void	CorrectWrapRound ()
	Corrects wrap around co-ordinate problems. More...

Protected Attributes
int	m_Age
	The rabbit's age. More...

TTypeOfRabbitState	m_CurrentRState
	Variable to record current behavioural state. More...

Rabbit_Population_Manager *	m_OurPopulationManager
	This is a time saving pointer to the correct population manager object. More...

double	m_MyMortChance

bool	m_haveBurrow
	Flag to record burrow status. More...

Rabbit_Warren *	m_myWarren
	True if currently mated. More...

Rabbit_Female *	m_Mum
	Pointer to mum. More...

bool	m_FedToday
	Flag for been fed today. More...

double	m_weight
	The weight in g. More...

int	m_weightAge
	A physiological age parameter, this is the growth age based on an optimal curve (if optimal conditions it will be the same as m_age) More...

int	m_digging
	Flag to denote digging behaviour. This keeps the rabbit in a warren without burrows whilst it tries to make one. More...

APoint	m_born_location
	The x,y location at birth. More...

double	m_pesticide_burden
	State variable used to hold the current body-burden of pesticide. More...

bool	m_pesticideInfluenced1
	Flag to indicate pesticide effects (e.g. can be used for endocrine distruptors with delayed effects until birth). More...

Protected Attributes inherited from TAnimal
int	m_Location_x

int	m_Location_y

Landscape *	m_OurLandscape

Protected Attributes inherited from TALMaSSObject
int	m_CurrentStateNo
	The basic state number for all objects - '-1' indicates death. More...

bool	m_StepDone
	Indicates whether the iterative step code is done for this timestep. More...

Detailed Description

Definition at line 166 of file Rabbit.h.

Constructor & Destructor Documentation

Rabbit_Base::Rabbit_Base	(	int	p_x,
		int	p_y,
		int	p_x2,
		int	p_y2,
		Landscape *	p_L,
		Rabbit_Population_Manager *	p_NPM,
		Rabbit_Warren *	a_warren
	)

Rabbit constructor.

Definition at line 161 of file Rabbit.cpp.

References Rabbit_Warren::Join(), m_born_location, m_CurrentRState, m_haveBurrow, m_myWarren, m_OurPopulationManager, m_pesticide_burden, m_pesticideInfluenced1, and toRabbits_InitialState.

                                                                                                                                         : TAnimal(p_x, p_y, p_L)
 {
     // Assign the pointer to the population manager
     m_OurPopulationManager = p_NPM;
     m_CurrentRState = toRabbits_InitialState;
     m_haveBurrow = false;
     m_myWarren = a_warren;
     m_born_location.m_x = p_x2;
     m_born_location.m_y = p_y2;
     if (m_myWarren != NULL) m_myWarren->Join(this);
     m_pesticideInfluenced1 = false;
     m_pesticide_burden = 0.0;
 }

Rabbit_Base::~Rabbit_Base ( void )

virtual

Rabbit destructor.

Definition at line 176 of file Rabbit.cpp.

References Rabbit_Warren::Leave(), and m_myWarren.

 {
     if (m_myWarren != NULL ) m_myWarren->Leave(this);
 }

Member Function Documentation

void Rabbit_Base::BeginStep ( void )

virtual

The BeginStep is the first 'part' of the timestep that an animal can behave in. It is called once per timestep.

Reimplemented from TAnimal.

Definition at line 182 of file Rabbit.cpp.

References m_Age, m_OurPopulationManager, Rabbit_Population_Manager::NatalDispersalRecordOutput(), CfgInt::value(), and CfgBool::value().

Referenced by Rabbit_Young::BeingStep().

                                   {
     if (m_Age == cfg_RabbitUseNatalDispersalRecordAge.value()) if (cfg_RabbitUseNatalDispersalRecord.value()) m_OurPopulationManager->NatalDispersalRecordOutput( this );
 }

virtual void Rabbit_Base::EndStep ( void )

inlinevirtual

The EndStep is the third 'part' of the timestep that an animal can behave in. It is called once per timestep.

Reimplemented from TAnimal.

Reimplemented in Rabbit_Adult, Rabbit_Juvenile, and Rabbit_Young.

Definition at line 272 of file Rabbit.h.

                                  {
         ;
     }

virtual void Rabbit_Base::Explore ( void )

inlineprotectedvirtual

Exploration method.

Definition at line 293 of file Rabbit.h.

                                  {
         ;
     }

virtual void Rabbit_Base::GeneralEndocrineDisruptor ( double )

inlineprotectedvirtual

Handles internal effects of endocrine distrupter pesticide exposure.

Reimplemented in Rabbit_Female.

Definition at line 307 of file Rabbit.h.

                                                        {
         ;
     }

void Rabbit_Base::GeneralOrganoPhosphate ( double )

protectedvirtual

Handles internal effects of organophosphate pesticide exposure.

Definition at line 1432 of file Rabbit.cpp.

References m_CurrentRState, m_OurPopulationManager, m_RabbitType, TALMaSSObject::m_StepDone, Rabbit_Population_Manager::PesticideDeathRecord(), and toRabbits_Die.

Referenced by Rabbit_Juvenile::InternalPesticideHandlingAndResponse(), Rabbit_Male::InternalPesticideHandlingAndResponse(), and Rabbit_Female::InternalPesticideHandlingAndResponse().

                                                    {
     //if (g_rand_uni() > l_pest_daily_mort.value()) return;
     m_OurPopulationManager->PesticideDeathRecord( m_RabbitType );
     m_CurrentRState = toRabbits_Die;
     m_StepDone = true;
     return;
 }

int Rabbit_Base::GetAge ( void )

inline

Get age method.

Definition at line 222 of file Rabbit.h.

                        {
         return m_Age;
     }

APoint Rabbit_Base::GetBornLocation ( )

inline

Get location of birth.

Definition at line 258 of file Rabbit.h.

                              {
         return m_born_location;
     }

TTypeOfRabbitState Rabbit_Base::GetCurrentRState ( )

inline

DEBUG method to get the current state

Definition at line 210 of file Rabbit.h.

Referenced by Rabbit_Warren::Leave().

                                           {
         return m_CurrentRState;
     }

int Rabbit_Base::GetDigging ( )

inline

Get number of days to dig.

Definition at line 254 of file Rabbit.h.

Referenced by Rabbit_Warren::JoinNMate(), Rabbit_Warren::Leave(), and Rabbit_Warren::Mate().

                      {
         return m_digging;
     }

bool Rabbit_Base::GetHasBurrow ( void )

inline

Get burrow status.

Definition at line 242 of file Rabbit.h.

Referenced by Rabbit_Adult::EndStep(), Rabbit_Warren::JoinNMate(), Rabbit_Warren::Leave(), and Rabbit_Warren::Mate().

                               {
         return m_haveBurrow;
     }

virtual Rabbit_Adult* Rabbit_Base::GetMate ( void )

inlinevirtual

Get mate pointer.

Reimplemented in Rabbit_Adult.

Definition at line 288 of file Rabbit.h.

Referenced by Rabbit_Warren::Leave().

                                           {
         return NULL;
     };

RabbitObjectTypes Rabbit_Base::GetRabbitType ( void )

inline

Get rabbit type.

Definition at line 218 of file Rabbit.h.

Referenced by Rabbit_Warren::Leave(), Rabbit_Adult::OnMateDead(), Rabbit_Adult::OnMateFinishedDigging(), and Rabbit_Adult::SetMate().

                                             {
         return m_RabbitType;
     }

Rabbit_Warren* Rabbit_Base::GetWarren ( void )

inline

Get warren pointer.

Definition at line 234 of file Rabbit.h.

                                      {
         return m_myWarren;
     }

int Rabbit_Base::GetweightAge ( void )

inline

Get age method.

Definition at line 230 of file Rabbit.h.

Referenced by Rabbit_Warren::ChooseNewDominant().

                              {
         return m_weightAge;
     }

virtual void Rabbit_Base::InternalPesticideHandlingAndResponse ( )

inlineprotectedvirtual

Handles internal effects of pesticide exposure. If any effects are needed this method must be re-implemented by descendent classes.

Reimplemented in Rabbit_Female, Rabbit_Male, and Rabbit_Juvenile.

Definition at line 303 of file Rabbit.h.

Referenced by Rabbit_Adult::EndStep().

                                                         {
         ;
     }

bool Rabbit_Base::MortalityTest ( double a_prop )

inlineprotected

A simple probability based test.

Parameters

[in] a_prop must be between 0 and <1.0 This is a simple probability test.

Definition at line 194 of file Rabbit.cpp.

References g_rand_uni.

Referenced by Rabbit_Juvenile::EndStep(), Rabbit_Adult::EndStep(), and Rabbit_Young::st_Develop().

 { 
     if (g_rand_uni() < a_prop) return true; 
         else return false; 
 }

void Rabbit_Base::OnEvicted ( void )

inline

Signals mum has a new litter to look after.

Definition at line 284 of file Rabbit.h.

References toRabbits_Weaning.

Referenced by Rabbit_Female::st_GiveBirth().

                            {
         m_Mum = NULL; m_CurrentRState = toRabbits_Weaning;
     }

void Rabbit_Base::OnFed ( void )

inline

Signals food arrived today.

Definition at line 276 of file Rabbit.h.

Referenced by Rabbit_Female::st_Lactating().

                        {
         m_FedToday = true;
     }

void Rabbit_Base::OnMumDead ( void )

inline

Signals death of mum.

Definition at line 280 of file Rabbit.h.

Referenced by Rabbit_Female::st_Dying().

                            {
         m_Mum = NULL;
     }

void Rabbit_Base::SetAge ( int a_age )

inline

Set age method.

Definition at line 214 of file Rabbit.h.

                              {
         m_Age = a_age;
     }

void Rabbit_Base::SetDigging ( int a_days )

inline

Set number of days to dig.

Definition at line 250 of file Rabbit.h.

Referenced by Rabbit_Warren::JoinNMate(), Rabbit_Warren::JoinNOccupy(), Rabbit_Warren::Leave(), Rabbit_Warren::Mate(), Rabbit_Warren::OccupyWarren(), Rabbit_Adult::OnMateFinishedDigging(), Rabbit_Male::st_EvaluateTerritory(), and Rabbit_Female::st_EvaluateTerritory().

                                   {
         m_digging = a_days;
     }

void Rabbit_Base::SetHasBurrow ( bool a_status )

inline

Set/unset burrow status.

Definition at line 246 of file Rabbit.h.

Referenced by Rabbit_Adult::EndStep(), Rabbit_Warren::JoinNMate(), Rabbit_Warren::JoinNOccupy(), Rabbit_Warren::Leave(), Rabbit_Warren::Mate(), Rabbit_Adult::OnMateFinishedDigging(), Rabbit_Male::st_EvaluateTerritory(), and Rabbit_Female::st_EvaluateTerritory().

                                        {
         m_haveBurrow = a_status;
     }

void Rabbit_Base::SetWarren ( Rabbit_Warren * a_warren )

inline

Set the warren pointer.

Definition at line 238 of file Rabbit.h.

Referenced by Rabbit_Warren::Join(), and Rabbit_Warren::Leave().

                                               {
         m_myWarren = a_warren;
     }

void Rabbit_Base::SetweightAge ( int a_age )

inline

Set age method.

Definition at line 226 of file Rabbit.h.

                                    {
         m_weightAge = a_age;
     }

void Rabbit_Base::st_Dying ( void )

protectedvirtual

Default dying state.

Reimplemented in Rabbit_Female, Rabbit_Adult, Rabbit_Juvenile, and Rabbit_Young.

Definition at line 187 of file Rabbit.cpp.

References TALMaSSObject::m_CurrentStateNo, and TALMaSSObject::m_StepDone.

Referenced by WalkTo().

 {
     m_CurrentStateNo = -1; // this will kill the animal object and free up space
     m_StepDone = true;
 }

virtual void Rabbit_Base::Step ( void )

inlinevirtual

The Step is the second 'part' of the timestep that an animal can behave in. It is called continuously until all animals report that they are 'DONE'.

Reimplemented from TAnimal.

Reimplemented in Rabbit_Female, Rabbit_Male, Rabbit_Juvenile, and Rabbit_Young.

Definition at line 268 of file Rabbit.h.

                               {
         ;
     }

bool Rabbit_Base::WalkTo	(	int	a_x,
		int	a_y
	)

protected

Walks to a location from current location.

Parameters

[in]	a_x	x-coordinate to move to
[in]	a_y	y-coordinate to move to

Returns: True if the rabbit still lives, otherwise false if it was killed in dispersal.

Assumes a rectangluar distance movement with associated probability of mortality by distance.

Definition at line 205 of file Rabbit.cpp.

References g_counter, g_rand_uni, m_dispersalmortperm, TAnimal::m_Location_x, TAnimal::m_Location_y, and st_Dying().

Referenced by Rabbit_Male::st_EvaluateTerritory(), and Rabbit_Female::st_EvaluateTerritory().

 { 
     int dist = abs(a_x-m_Location_x) + abs(a_y-m_Location_y);
     double prob = dist * m_dispersalmortperm;
     m_Location_x = a_x;
     m_Location_y = a_y;
     if (g_rand_uni() > prob) return true; 
         else 
         {
             st_Dying();
             g_counter++;
             return false; 
         }
 }