The rabbit male class. All special male behaviour is described here. More...

#include <Rabbit.h>

Inheritance diagram for Rabbit_Male:

Public Member Functions
	Rabbit_Male (int p_x, int p_y, int p_x2, int p_y2, Landscape p_L, Rabbit_Population_Manager p_NPM, int a_age, int a_weightage, Rabbit_Warren *a_warren)
	Rabbit_Male constructor. More...

virtual	~Rabbit_Male (void)
	Rabbit_Male destructor. More...

virtual void	Step (void)
	The male rabbit step code. More...

Public Member Functions inherited from Rabbit_Adult
	Rabbit_Adult (int p_x, int p_y, int p_x2, int p_y2, Landscape p_L, Rabbit_Population_Manager p_NPM, int a_age, int a_weightage, Rabbit_Warren *a_warren)
	Rabbit_Adult constructor. More...

virtual	~Rabbit_Adult ()
	Rabbit_Adult destructor. More...

TTypesOfRabbitSocialStatus	GetSocialStatus (void)
	Return the dominance status. More...

void	SetSocialStatus (TTypesOfRabbitSocialStatus a_status)
	Sets the dominance status. More...

void	SetMate (Rabbit_Adult *a_mate)
	Set/unset mate status. More...

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

void	OnMateFinishedDigging (Rabbit_Adult *a_mate)
	Action when a mate has finished digging a burrow. More...

void	OnMateDead (Rabbit_Adult *a_mate)
	Set/unset mate status. More...

Public Member Functions inherited from Rabbit_Base
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...

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...

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...

Protected Member Functions
virtual TTypeOfRabbitState	st_EvaluateTerritory (void)
	Male Evaluate Territory Step. More...

virtual TTypeOfRabbitState	st_Forage (void)
	Adult male forage behaviour. More...

virtual void	InternalPesticideHandlingAndResponse ()
	Handles internal effects of pesticide exposure - reimplemented from base class. More...

Protected Member Functions inherited from Rabbit_Adult
virtual void	st_Dying (void)
	Default dying state. More...

virtual void	EndStep (void)
	The EndStep is the last 'part' of the timestep that an animal can behave in. More...

Protected Member Functions inherited from Rabbit_Base
virtual void	Explore (void)
	Exploration method. 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	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...

Additional Inherited Members
Public Attributes inherited from Rabbit_Base
RabbitObjectTypes	m_RabbitType
	The rabbits type. More...

Static Public Attributes inherited from Rabbit_Base
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 Attributes inherited from Rabbit_Adult
TTypesOfRabbitSocialStatus	m_socialstatus
	Flag to record dominance status (0-4) More...

int	m_lifespan
	The rabbit's alloted lifespan. More...

Rabbit_Adult *	m_myMate
	Pointer to the mate if any. More...

Protected Attributes inherited from Rabbit_Base
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

The rabbit male class. All special male behaviour is described here.

Definition at line 422 of file Rabbit.h.

Constructor & Destructor Documentation

◆ Rabbit_Male()

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

Rabbit_Male constructor.

Definition at line 719 of file Rabbit.cpp.

                                                                                                                                                                     : Rabbit_Adult(p_x, p_y, p_x2, p_y2, p_L, p_NPM, a_age, a_weightage, a_warren)
 {
     m_RabbitType = rob_Male;
     if (a_warren != NULL) a_warren->RabbitProductionRecord(rob_Male, 1);
 }

References Rabbit_Base::m_RabbitType, Rabbit_Warren::RabbitProductionRecord(), and rob_Male.

◆ ~Rabbit_Male()

Rabbit_Male::~Rabbit_Male ( void )

virtual

Rabbit_Male destructor.

Definition at line 726 of file Rabbit.cpp.

 {
     ;
 }

Member Function Documentation

◆ InternalPesticideHandlingAndResponse()

void Rabbit_Male::InternalPesticideHandlingAndResponse ( )

protectedvirtual

Handles internal effects of pesticide exposure - reimplemented from base class.

This method is re-implemented ffrom Rabbit_Base for any class which has pesticide response behaviour. If the body burden exceeds the trigger then call pesticide-specific actions by dose

Reimplemented from Rabbit_Base.

Definition at line 1370 of file Rabbit.cpp.

                                                        {
     TTypesOfPesticide tp = m_OurLandscape->SupplyPesticideType();
     double pesticideInternalConc = m_pesticide_burden / m_weight;
  
     if (pesticideInternalConc > cfg_RabbitPesticideResponse.value()) {
         switch (tp) {
             case ttop_NoPesticide:
                 break;
             case ttop_ReproductiveEffects:
                 break;
             case ttop_AcuteEffects:
                 GeneralOrganoPhosphate( pesticideInternalConc ); // Calls the GeneralOrganophosphate action code
                 break;
             default:
                 g_msg->Warn( "Unknown pesticide type used in Rabbit_Male::InternalPesticideHandlingAndResponse() pesticide code ", int( tp ) );
                 exit( 47 );
         }
     }
     m_pesticide_burden *= m_pesticidedegradationrate; // Does nothing by default except internal degredation of the pesticide
 }

References cfg_RabbitPesticideResponse, g_msg, Rabbit_Base::GeneralOrganoPhosphate(), TAnimal::m_OurLandscape, Rabbit_Base::m_pesticide_burden, Rabbit_Base::m_pesticidedegradationrate, Rabbit_Base::m_weight, Landscape::SupplyPesticideType(), ttop_AcuteEffects, ttop_NoPesticide, ttop_ReproductiveEffects, CfgFloat::value(), and MapErrorMsg::Warn().

◆ st_EvaluateTerritory()

TTypeOfRabbitState Rabbit_Male::st_EvaluateTerritory ( void )

protectedvirtual

Male Evaluate Territory Step.

Returns: The next behavioural state. The only legal returns are toRabbits_EvaluateTerritory and toRabbits_Die

The rabbit must evaluate his territory and decide if he will stay or leave. This decision is based on a number of criteria:

An evaluation of the social mate status
An evaluation of the current mate status
An evaluation of the current territory quality
A comparison with potential areas explored nearby

Here we make the assumption that if suitable quality unoccupied territory is known to be available and the rabbit is not dominant, then it will move to set up a territory there. If none is avaible or known, then the rabbit will remain as subordinate as long as the current territory can support him. If he is forced out he must find a vacent place or will die. If he stays he may become dominant one day.

If he has no mate (he may be digging and not have a burrow) then before anything else we need to evaluate our current warren for possibilities - could be vacant burrow or mate here for us. If no warren for some reason (could be start-up conditions), then find one.

Next he moves there, and assesses whether he can join

If there is a free burrow then joining is certain. If the warren site is unoccupied then currently the rabbit will join it and start to dig. This behaviour might need to be altered later, if rabbits might not start up alone so easily.

If nothing doing locally the Rabbit will move if conditions elsewhere are better and is not dominant or mated:

If itinerent, possible free territory -> move
If a mate is possible in the new place -> move

Definition at line 776 of file Rabbit.cpp.

                                                            {
     if (m_socialstatus > rabbit_socialstatus_subordinate) return toRabbits_Foraging; // Do it all again tomorrow, we are at the top or near the top of the heap in social terms
     if (m_myMate != NULL) {
 #ifdef __RABBITDEBUG
         if (m_digging < 0) {
             int rubbish = 0;
         }
         if (m_haveBurrow) {
             int rubbish = 0;
         }
 #endif
         return toRabbits_Foraging; // Must be digging a burrow
     }
  
     if (m_myWarren == NULL) {
         // Must find a warren - finds the closest - NB this code should not often be used, so efficiency here has not been optimised
         Rabbit_Warren* aRW = m_OurPopulationManager->FindClosestWarren( m_Location_x, m_Location_y, 1 );
         bool survived = WalkTo( aRW->Supply_m_Location_x(), aRW->Supply_m_Location_y() );
         if (!survived) return toRabbits_Die;
         if (aRW->IsFreeFemale()) {
             aRW->JoinNMate( this, rob_Female );
         }
         else {
             int burrow = aRW->IsFreeBurrow();
             if (burrow == 1) {
                 aRW->JoinNOccupy( this );
             }
             else
                 if (burrow == 2) {
                     aRW->OccupyWarren( this );
                 }
         }
         return toRabbits_Foraging;
     }
     else if (m_myWarren->IsFreeFemale()) {
         m_myWarren->Mate( this, rob_Female );
     }
     else if (m_myWarren->IsFreeBurrow() == 1) {
         m_myWarren->OccupyBurrow( );
         SetDigging( -1 );
         SetSocialStatus( rabbit_socialstatus_subdominant );
         SetHasBurrow( true );
     }
     else    if (m_digging > 0) {
         return toRabbits_Foraging;
     }
     else
     {
         Rabbit_Warren* aWarren = m_myWarren->GetNetworkWarren();
         if (aWarren != NULL) {
             if (aWarren->IsFreeFemale()) {
                 bool survived = WalkTo( aWarren->Supply_m_Location_x(), aWarren->Supply_m_Location_y() );
                 if (!survived) return toRabbits_Die;
                 m_myWarren->Leave( this );
                 aWarren->JoinNMate( this, rob_Female );
             }
             else {
                 int burrows = aWarren->IsFreeBurrow();
                 if (burrows == 1) {
                     bool survived = WalkTo( aWarren->Supply_m_Location_x(), aWarren->Supply_m_Location_y() );
                     if (!survived) return toRabbits_Die;
                     m_myWarren->Leave( this );
                     aWarren->JoinNOccupy( this );
                     m_socialstatus = rabbit_socialstatus_subdominant;
                 }
                 else if (burrows == 2) {
                     bool survived = WalkTo( aWarren->Supply_m_Location_x(), aWarren->Supply_m_Location_y() );
                     if (!survived) return toRabbits_Die;
                     m_myWarren->Leave( this );
                     aWarren->OccupyWarren( this );
                     m_socialstatus = rabbit_socialstatus_subordinate; // Can dig a burrow but don't have one
                 }
                 else {
                     // No room but we may need to move anyway
                     int c = m_myWarren->GetCarryingCapacity();
                     int n = m_myWarren->GetPopulationSize() - (c * 2);  // c is number of pairs, but there are 2 + a litter (average 6) as a minimum
                     double occupation = n / (double)c;
                     if (g_rand_uni() < occupation) {
                         bool survived = WalkTo( aWarren->Supply_m_Location_x(), aWarren->Supply_m_Location_y() );
                         if (!survived) return toRabbits_Die;
                         m_myWarren->Leave( this );
                         aWarren->Join( this );
                         SetDigging( -1 );
                         m_socialstatus = rabbit_socialstatus_zero;
                     }
                 }
             }
         }
     }
     return toRabbits_Foraging; // Do it all again tomorrow
 }

References Rabbit_Population_Manager::FindClosestWarren(), g_rand_uni, Rabbit_Warren::GetCarryingCapacity(), Rabbit_Warren::GetNetworkWarren(), Rabbit_Warren::GetPopulationSize(), Rabbit_Warren::IsFreeBurrow(), Rabbit_Warren::IsFreeFemale(), Rabbit_Warren::Join(), Rabbit_Warren::JoinNMate(), Rabbit_Warren::JoinNOccupy(), Rabbit_Warren::Leave(), Rabbit_Base::m_digging, Rabbit_Base::m_haveBurrow, TAnimal::m_Location_x, TAnimal::m_Location_y, Rabbit_Adult::m_myMate, Rabbit_Base::m_myWarren, Rabbit_Base::m_OurPopulationManager, Rabbit_Adult::m_socialstatus, Rabbit_Warren::Mate(), Rabbit_Warren::OccupyBurrow(), Rabbit_Warren::OccupyWarren(), rabbit_socialstatus_subdominant, rabbit_socialstatus_subordinate, rabbit_socialstatus_zero, rob_Female, Rabbit_Base::SetDigging(), Rabbit_Base::SetHasBurrow(), Rabbit_Adult::SetSocialStatus(), TAnimal::Supply_m_Location_x(), TAnimal::Supply_m_Location_y(), toRabbits_Die, toRabbits_Foraging, and Rabbit_Base::WalkTo().

Referenced by Step().

◆ st_Forage()

TTypeOfRabbitState Rabbit_Male::st_Forage ( void )

protectedvirtual

Adult male forage behaviour.

This is a critical part of the pesticide handling code. The rabbit forages from the warren area and as a result picks up pesticide. Exactly how much pesticide is picked up depends on the assumptions regarding foraging behaviour. These can be altered here, but the default assumption is that the rabbit will forage from all suitable forgage locations equally, and therefore will pick up an average or maximum dose based on the concentration of residue in the forage areas. This is precalculated by the Rabbit_Warren in UpdatePesticide. The pesticide response code is placed in EndStep - this will determine direct mortality or set any necessary flags indicating pesticide effects later, e.g. for reproduction.

Definition at line 762 of file Rabbit.cpp.

 {
     if (m_myWarren != NULL) m_pesticide_burden+= m_myWarren->GetForagePesticide();
     return toRabbits_EvaluateTerritory;
 }

References Rabbit_Warren::GetForagePesticide(), Rabbit_Base::m_myWarren, Rabbit_Base::m_pesticide_burden, and toRabbits_EvaluateTerritory.

Referenced by Step().

◆ Step()

void Rabbit_Male::Step ( void )

virtual

The male rabbit step code.

Reimplemented from Rabbit_Base.

Definition at line 732 of file Rabbit.cpp.

 {
     if (m_StepDone || m_CurrentStateNo == -1) return;
     switch (m_CurrentRState)
     {
      case toRabbits_InitialState: // Initial state always starts with develop
          m_CurrentRState=toRabbits_Foraging;
          break;
      case toRabbits_EvaluateTerritory: // Initial state always starts with develop
          m_CurrentRState=st_EvaluateTerritory();
          m_StepDone=true;
          break;
      case toRabbits_Foraging:
          m_CurrentRState=st_Forage();
          break;
      case toRabbits_Die:
          st_Dying(); // No return value - no behaviour after this
          m_StepDone=true;
          break;
      case toRabbits_Remove:
          m_CurrentStateNo = -1;
          m_StepDone=true;
          break;
      default:
          m_OurLandscape->Warn("Rabbit_Male::Step()","unknown state - default");
          exit(1);
     }
 }

References Rabbit_Base::m_CurrentRState, TALMaSSObject::m_CurrentStateNo, TAnimal::m_OurLandscape, TALMaSSObject::m_StepDone, Rabbit_Adult::st_Dying(), st_EvaluateTerritory(), st_Forage(), toRabbits_Die, toRabbits_EvaluateTerritory, toRabbits_Foraging, toRabbits_InitialState, toRabbits_Remove, and Landscape::Warn().

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

C:/Repo/ALMaSS_all/Rabbit/Rabbit.h
C:/Repo/ALMaSS_all/Rabbit/Rabbit.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Rabbit_Male()

◆ ~Rabbit_Male()

Member Function Documentation

◆ InternalPesticideHandlingAndResponse()

◆ st_EvaluateTerritory()

◆ st_Forage()

◆ Step()