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

#include <Rabbit.h>

Inheritance diagram for Rabbit_Female:

Public Member Functions
	Rabbit_Female (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_Female constructor. More...

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

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

void	AddYoung (Rabbit_Young *a_young)
	Add a young. More...

void	OnYoungDeath (Rabbit_Young *a_young)
	Message on death of a young. More...

void	Weaned (Rabbit_Young *a_young)
	Message on weaning of a young. More...

void	SetMinKits (double a_num)

void	SetMaxKits (double a_num)

int	GetTotalOffspring ()

int	GetTotalLitters ()

int	GetLittersThisYear ()

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)
	Female Evaluate Territory Step. More...

virtual TTypeOfRabbitState	st_UpdateBreedingStatus (void)
	Female reproductive update - handles oestrous, gestation, lactation and birth. More...

virtual TTypeOfRabbitState	st_GiveBirth (void)
	Female give birth state. More...

virtual TTypeOfRabbitState	st_Lactating (void)
	Female lactating state. More...

virtual TTypeOfRabbitState	st_Gestating (void)
	Female gestating state. More...

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

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

int	CalcLitterSize (void)
	Calculates the litter size at birth. More...

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

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

Protected Member Functions inherited from Rabbit_Adult
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	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
bool	m_pregnant
	Flag to indicate pregnancy. More...

bool	m_lactating
	Flag to indicate lactating. More...

int	m_gestationcounter
	Counter to record the number of days gestating. More...

Rabbit_Young *	m_myLitter [20]
	Holds the current young (for lactation) More...

int	m_myLitterSize
	Holds the current litter size. More...

int	m_MyOffspring
	The total number of kits born to her. More...

int	m_MyTotalLitters
	The number of litters produced. More...

vector< int >	m_AnnualLitters
	The number of litters produced. 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...

Static Protected Attributes
static double	m_MinKitsNo = cfg_rabbitminkits.value()
	The minimum number of kits. More...

static double	m_MaxKitsNo = cfg_rabbitmaxkits.value() - cfg_rabbitminkits.value()
	The maximum number of kits. 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...

Detailed Description

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

Definition at line 443 of file Rabbit.h.

Constructor & Destructor Documentation

◆ Rabbit_Female()

Rabbit_Female::Rabbit_Female	(	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_Female constructor.

Definition at line 900 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_Female;
     if (a_warren != NULL) a_warren->RabbitProductionRecord(rob_Female, 1);
     m_lactating = false;
     m_pregnant = false;
     m_gestationcounter = 0;
     m_myLitterSize = 0;
     m_MyOffspring = 0;
     m_MyTotalLitters = 0;
 #ifdef __RABBITDEBUG
  if (m_myWarren != NULL) if (m_myWarren->IsMember(this)==false)
  {
          m_OurLandscape->Warn("Rabbit_Female::Rabbit_Female","not a member of our warren");
          exit(1);
  }
 #endif
 }

References Rabbit_Warren::IsMember(), m_gestationcounter, m_lactating, m_myLitterSize, m_MyOffspring, m_MyTotalLitters, Rabbit_Base::m_myWarren, TAnimal::m_OurLandscape, m_pregnant, Rabbit_Base::m_RabbitType, Rabbit_Warren::RabbitProductionRecord(), rob_Female, and Landscape::Warn().

◆ ~Rabbit_Female()

Rabbit_Female::~Rabbit_Female ( void )

virtual

Rabbit_Female destructor.

Definition at line 920 of file Rabbit.cpp.

 {
     ;
 }

Member Function Documentation

◆ AddYoung()

void Rabbit_Female::AddYoung ( Rabbit_Young * a_young )

inline

Add a young.

Definition at line 454 of file Rabbit.h.

     { 
         m_myLitter[m_myLitterSize++] = a_young; 
     }

References m_myLitter, and m_myLitterSize.

◆ CalcLitterSize()

int Rabbit_Female::CalcLitterSize ( void )

protected

Calculates the litter size at birth.

This determines how many young are born in a litter. Litter sizes are 3-8 young, but what controls this is not yet implemented, currently the results are stochastic between these extremes. However, there appears to be no consensus in the literature about this. Larger females have more young, but survival seems also to be greater for individuals of smaller litters. Since this seems to balance out uniform variation and standardised subsequent survival have been implemented.

Definition at line 1255 of file Rabbit.cpp.

 {
     return int(floor(m_MinKitsNo + g_rand_uni() * m_MaxKitsNo));
 }

References g_rand_uni, m_MaxKitsNo, and m_MinKitsNo.

Referenced by st_GiveBirth().

◆ GeneralEndocrineDisruptor()

void Rabbit_Female::GeneralEndocrineDisruptor ( double )

protectedvirtual

Handles internal effects of endocrine distrupter pesticide exposure.

For rabbits, only the female responds to this type of pesticide

Reimplemented from Rabbit_Base.

Definition at line 1424 of file Rabbit.cpp.

                                                         {
     // May also wish to specify certain gestation days for the effects here
     if (m_gestationcounter > 0) {
         m_pesticideInfluenced1 = true;
     }
 }

References m_gestationcounter, and Rabbit_Base::m_pesticideInfluenced1.

Referenced by InternalPesticideHandlingAndResponse().

◆ GetLittersThisYear()

int Rabbit_Female::GetLittersThisYear ( )

inline

Definition at line 466 of file Rabbit.h.

                              {
         return static_cast<int>(m_AnnualLitters.size());
     }

References m_AnnualLitters.

◆ GetTotalLitters()

int Rabbit_Female::GetTotalLitters ( )

inline

Definition at line 465 of file Rabbit.h.

465 { return m_MyTotalLitters; }

References m_MyTotalLitters.

Referenced by Rabbit_Population_Manager::ReproOutputRecordOutput().

◆ GetTotalOffspring()

int Rabbit_Female::GetTotalOffspring ( )

inline

Definition at line 464 of file Rabbit.h.

464 { return m_MyOffspring; }

References m_MyOffspring.

Referenced by Rabbit_Population_Manager::ReproOutputRecordOutput().

◆ InternalPesticideHandlingAndResponse()

void Rabbit_Female::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 1395 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:
                 GeneralEndocrineDisruptor( pesticideInternalConc ); // Calls the EndocrineDisruptor action code
                 break;
             case ttop_AcuteEffects:
                 GeneralOrganoPhosphate( pesticideInternalConc ); // Calls the GeneralOrganophosphate action code
                 break;
             default:
                 g_msg->Warn( "Unknown pesticide type used in Rabbit_Female::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, GeneralEndocrineDisruptor(), 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().

◆ OnYoungDeath()

void Rabbit_Female::OnYoungDeath ( Rabbit_Young * a_young )

Message on death of a young.

If a young has died then it is removed from the litter list. If it is the last one, then lactation is stopped immediately.

Definition at line 1293 of file Rabbit.cpp.

 {
     for(int l=0; l<m_myLitterSize; l++) 
     {
         if (m_myLitter[l] == a_young)
         {
             for (int n=l; n<m_myLitterSize; n++)
             {
                 m_myLitter[n] = m_myLitter[n+1];
             }
             m_myLitter[--m_myLitterSize] = NULL;
             if (m_myLitterSize == 0) m_lactating = false;
             return;
         }
     }
     // If we get here there is an error
     m_OurLandscape->Warn("Rabbit_Female::OnYoungDeath","unknown litter member");
     exit(1);
 }

References m_lactating, m_myLitter, m_myLitterSize, TAnimal::m_OurLandscape, and Landscape::Warn().

Referenced by Rabbit_Young::EndStep(), and Rabbit_Young::st_Dying().

◆ SetMaxKits()

void Rabbit_Female::SetMaxKits ( double a_num )

inline

Definition at line 463 of file Rabbit.h.

463 { m_MaxKitsNo = a_num; }

References m_MaxKitsNo.

Referenced by Rabbit_Population_Manager::AssignStaticVariables().

◆ SetMinKits()

void Rabbit_Female::SetMinKits ( double a_num )

inline

Definition at line 462 of file Rabbit.h.

462 { m_MinKitsNo = a_num; }

References m_MinKitsNo.

Referenced by Rabbit_Population_Manager::AssignStaticVariables().

◆ st_Dying()

void Rabbit_Female::st_Dying ( void )

protectedvirtual

Female dying state.

Female dying state. Needs to:

Tell any young
Pass the mantle of dominance on if they are dominant
Perform the adult dying actions

Reimplemented from Rabbit_Adult.

Definition at line 973 of file Rabbit.cpp.

 {
     for(int l=0; l<m_myLitterSize; l++) 
     {
         m_myLitter[l]->OnMumDead();
     }
     if (m_socialstatus == rabbit_socialstatus_dominant) {
         m_myWarren->ChooseNewDominant();
     }
     // Record our repro output if needed
     if (cfg_RabbitUseReproOutput.value()) m_OurPopulationManager->ReproOutputRecordOutput(this);
     Rabbit_Adult::st_Dying();
 }

References cfg_RabbitUseReproOutput, Rabbit_Warren::ChooseNewDominant(), m_myLitter, m_myLitterSize, Rabbit_Base::m_myWarren, Rabbit_Base::m_OurPopulationManager, Rabbit_Adult::m_socialstatus, Rabbit_Base::OnMumDead(), rabbit_socialstatus_dominant, Rabbit_Population_Manager::ReproOutputRecordOutput(), Rabbit_Adult::st_Dying(), and CfgBool::value().

Referenced by Step().

◆ st_EvaluateTerritory()

TTypeOfRabbitState Rabbit_Female::st_EvaluateTerritory ( void )

protectedvirtual

Female Evaluate Territory Step.

Returns: The next behavioural state. Legal returns are toRabbits_Foraging, toRabbits_UpdateBreedingStatus, and toRabbits_Die

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

An evaluation of the current mate status
An evaluation of the current social 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 her. If she is forced out she must find a vacent place or will die. If she stays she may become dominant one day.

No mate so 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, then find one.

If an itinerant then she must find a warren. Finds the closest - NB this code should not often be used, so efficiency here has not been optimised

Next she moves there, and assesses whether she 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
If itinerent there is a chance of moving even if to nothing better

Definition at line 994 of file Rabbit.cpp.

                                                              {
     // We need to manage our annual repro info
     int today = m_OurLandscape->SupplyGlobalDate();
     for (int l = static_cast<int>(m_AnnualLitters.size()-1); l >= 0; l--) {
         if (today - m_AnnualLitters[ l ] > 365) {
             m_AnnualLitters.erase( m_AnnualLitters.begin() + (l) );
         }
     }
 #ifdef __RABBITDEBUG
     if (m_myWarren != NULL)
     {
         if (m_myWarren->IsMember( this ) == false) {
             m_OurLandscape->Warn( "Rabbit_Female::st_EvaluateTerritory", "not a member of our warren" );
             exit( 1 );
         }
     }
 #endif
     if (m_socialstatus > rabbit_socialstatus_subordinate) {
 #ifdef __RABBITDEBUG
         if (m_myMate != NULL) {
             int rubbish = 0;
         }
 #endif
         return toRabbits_UpdateBreedingStatus; // No need to check the rest we have it all
     }
     // Update breeding status needs StepDone == false, but otherwise we need to set StepDone here.
     m_StepDone = true;
     if (m_myMate != NULL) {
         return toRabbits_Foraging; // Must be digging a burrow
     }
     if (m_myWarren == NULL) {
         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->IsFreeMale()) {
             aRW->JoinNMate( this, rob_Male );
         }
         else {
             int burrow = aRW->IsFreeBurrow();
             if (burrow == 1) {
                 aRW->JoinNOccupy( this );
             }
             else
                 if (burrow == 2) {
                     aRW->OccupyWarren( this );
                 }
  
         }
         return toRabbits_Foraging;
     }
     // We have a warren but no mate or burrow
     else if (m_myWarren->IsFreeMale()) {
         m_myWarren->Mate( this, rob_Male );
     }
     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->IsFreeMale()) {
                 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_Male );
             }
             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_subdominant;
                 }
                 else {
                     // No room but we may need to move anyway
                     double dispersalchance = m_myWarren->GetAvailableForage()/5.0;
                     if (g_rand_uni() < dispersalchance) {
                         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;
                     }
                 }
             }
         }
     }
 #ifdef __RABBITDEBUG
     if (m_myWarren != NULL) if (m_myWarren->IsMember( this ) == false) {
         m_OurLandscape->Warn( "Rabbit_Female::st_EvaluateTerritory", "not a member of our warren" );
         exit( 1 );
     }
 #endif
     return toRabbits_Foraging; // Do it all again tomorrow
 }

References Rabbit_Population_Manager::FindClosestWarren(), g_rand_uni, Rabbit_Warren::GetAvailableForage(), Rabbit_Warren::GetNetworkWarren(), Rabbit_Warren::IsFreeBurrow(), Rabbit_Warren::IsFreeMale(), Rabbit_Warren::IsMember(), Rabbit_Warren::Join(), Rabbit_Warren::JoinNMate(), Rabbit_Warren::JoinNOccupy(), Rabbit_Warren::Leave(), m_AnnualLitters, Rabbit_Base::m_digging, TAnimal::m_Location_x, TAnimal::m_Location_y, Rabbit_Adult::m_myMate, Rabbit_Base::m_myWarren, TAnimal::m_OurLandscape, Rabbit_Base::m_OurPopulationManager, Rabbit_Adult::m_socialstatus, TALMaSSObject::m_StepDone, Rabbit_Warren::Mate(), Rabbit_Warren::OccupyBurrow(), Rabbit_Warren::OccupyWarren(), rabbit_socialstatus_subdominant, rabbit_socialstatus_subordinate, rabbit_socialstatus_zero, rob_Male, Rabbit_Base::SetDigging(), Rabbit_Base::SetHasBurrow(), Rabbit_Adult::SetSocialStatus(), TAnimal::Supply_m_Location_x(), TAnimal::Supply_m_Location_y(), Landscape::SupplyGlobalDate(), toRabbits_Die, toRabbits_Foraging, toRabbits_UpdateBreedingStatus, Rabbit_Base::WalkTo(), and Landscape::Warn().

Referenced by Step().

◆ st_Forage()

TTypeOfRabbitState Rabbit_Female::st_Forage ( void )

protectedvirtual

Adult female 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 int GetForagePesticide(), but the default assumption is that the rabbit will forage from all suitable forgage locations equally, and therefore will pick up an average dose based on the average concentration of residue in the forage areas (there is an alternative version that picks the maximum concentration). 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 1183 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().

◆ st_Gestating()

TTypeOfRabbitState Rabbit_Female::st_Gestating ( void )

protectedvirtual

Female gestating state.

Updates gestation counter and if still lactating returns a suitable return state, unless its time to give birth.

Definition at line 1279 of file Rabbit.cpp.

 {
     m_gestationcounter++;
     if (m_gestationcounter >= 30) {
         return toRabbits_GiveBirth;
     }
     if (m_lactating) return toRabbits_Lactating;
     return toRabbits_Foraging;
 }

References m_gestationcounter, m_lactating, toRabbits_Foraging, toRabbits_GiveBirth, and toRabbits_Lactating.

Referenced by Step().

◆ st_GiveBirth()

TTypeOfRabbitState Rabbit_Female::st_GiveBirth ( void )

protectedvirtual

Female give birth state.

Produces kits. If currently lactating then expels the current young. If it is the breeding season and she has a mate, then she becomes pregnant again immediately. Whether the pregancy is successful will depend on the social status. If social status is too low they cannot reproduce, sub dominant has % chance to reproduce. Reproduction will also depend on the current forage and density

Definition at line 1197 of file Rabbit.cpp.

                                                      {
     if (m_myLitterSize > 0) {
         for (int l = 0; l < m_myLitterSize; l++) {
             m_myLitter[ l ]->OnEvicted();
             m_myLitter[ l ] = NULL;
         }
         m_myLitterSize = 0;
     }
     if (!m_pesticideInfluenced1) {
         // Here we take both social status and weight into account
         if (m_socialstatus != rabbit_socialstatus_dominant) {
             if (((double)m_socialstatus*g_rand_uni()* (m_weightAge / 300.0) < cfg_rabbitsocialreproductionthreshold.value())) return toRabbits_Foraging;
         }
         int kits = 0;
         // Here we have a test for re-abosorption of the litter depending on forage conditions. Low forage high chance of re-absorption
         if (g_rand_uni() > m_myWarren->GetLitterReabsortionConst()) {
             struct_Rabbit* sR = new struct_Rabbit;
             sR->m_age = 0;
             sR->m_L = m_OurLandscape;
             sR->m_NPM = m_OurPopulationManager;
             sR->m_x = m_Location_x;
             sR->m_y = m_Location_y;
             sR->m_x2 = m_Location_x;
             sR->m_y2 = m_Location_y;
             sR->m_Warren = m_myWarren;
             kits = CalcLitterSize();
             m_OurPopulationManager->CreateObjects( rob_Young, this, sR, kits );
             m_myWarren->RabbitProductionRecord( rob_Young, kits );
             delete sR;
         }
         if (kits > 0) {
             m_lactating = true;
             // Record our success
             m_MyTotalLitters++;
             m_MyOffspring += kits;
             // We also need to manage our annual repro info
             m_AnnualLitters.push_back( m_OurLandscape->SupplyGlobalDate() );
         }
     }
     else {
         m_pesticideInfluenced1 = false; // Reset the pesticide flag since we lost the litter
         m_OurPopulationManager->PesticideDeathRecord( rob_Young );
     }
     if (m_OurPopulationManager->IsBreedingSeason()) {
         if (m_myMate != NULL) {
             m_pregnant = true;
             m_gestationcounter = 0;
         }
     }
     return toRabbits_Foraging;
 }

References CalcLitterSize(), cfg_rabbitsocialreproductionthreshold, Rabbit_Population_Manager::CreateObjects(), g_rand_uni, Rabbit_Warren::GetLitterReabsortionConst(), Rabbit_Population_Manager::IsBreedingSeason(), struct_Rabbit::m_age, m_AnnualLitters, m_gestationcounter, struct_Rabbit::m_L, m_lactating, TAnimal::m_Location_x, TAnimal::m_Location_y, m_myLitter, m_myLitterSize, Rabbit_Adult::m_myMate, m_MyOffspring, m_MyTotalLitters, Rabbit_Base::m_myWarren, struct_Rabbit::m_NPM, TAnimal::m_OurLandscape, Rabbit_Base::m_OurPopulationManager, Rabbit_Base::m_pesticideInfluenced1, m_pregnant, Rabbit_Adult::m_socialstatus, struct_Rabbit::m_Warren, Rabbit_Base::m_weightAge, struct_Rabbit::m_x, struct_Rabbit::m_x2, struct_Rabbit::m_y, struct_Rabbit::m_y2, Rabbit_Base::OnEvicted(), Rabbit_Population_Manager::PesticideDeathRecord(), rabbit_socialstatus_dominant, Rabbit_Warren::RabbitProductionRecord(), rob_Young, Landscape::SupplyGlobalDate(), toRabbits_Foraging, and CfgFloat::value().

Referenced by Step().

◆ st_Lactating()

TTypeOfRabbitState Rabbit_Female::st_Lactating ( void )

protectedvirtual

Female lactating state.

Rotates round each of the current young and gives them milk. If this does not happen for some reason then the young will automatically die

Definition at line 1266 of file Rabbit.cpp.

 {
     for(int lit=0; lit<m_myLitterSize; lit++) 
     {
         m_myLitter[lit]->OnFed();
     }
     return toRabbits_Foraging;
 }

References m_myLitter, m_myLitterSize, Rabbit_Base::OnFed(), and toRabbits_Foraging.

Referenced by Step().

◆ st_UpdateBreedingStatus()

TTypeOfRabbitState Rabbit_Female::st_UpdateBreedingStatus ( void )

protectedvirtual

Female reproductive update - handles oestrous, gestation, lactation and birth.

Returns: The repro behaviour to exhibit. Legal returns are: toRabbits_Gestation, toRabbits_GiveBirth, toRabbits_Lactating, toRabbits_Foraging

Determines where we are in the reproductive cycle. Will hold off or switch on oestrous depending upon season, otherwise will update gestation, continue lactating, mate or give birth as necessary. This uses a number of flags and counters specific to the female rabbit to achieve this. NB if she comes into oestrous and has a mate she will automatically become pregnant. Whether this will happen depends on the weather. Initially we assume that the average temperature over the last month determines intiation of breeding. Cessation may be more problematical. If lactating then the young are forced out at 30 days, when she can be giving birth again if it is still breeding season. If it is not breeding season and nothing else is happening then evaulate territory. This requires setting StepDone to true to prevent continuous looping.

Definition at line 1138 of file Rabbit.cpp.

 {
     if (m_OurPopulationManager->IsBreedingSeason()) 
     {
         // Do we have a litter on the way?
         if (m_pregnant) 
         {
             return toRabbits_Gestation;
         }
         else 
         {
             // Not pregnant but breeding season so check if there is a mate.
             if (m_myMate != NULL)
             {
                 m_pregnant = true;
                 m_gestationcounter = 0;
             }
             else if (m_myWarren->IsFreeMale())
             {
                 m_myWarren->Mate( this, rob_Male );
             }
         }
         return toRabbits_Foraging;
     }
     // Not breeding season but may have young
     if (m_lactating) return toRabbits_Lactating;
     else
     {
         m_gestationcounter = 0;
         return toRabbits_Foraging;
     }
 }

References Rabbit_Population_Manager::IsBreedingSeason(), Rabbit_Warren::IsFreeMale(), m_gestationcounter, m_lactating, Rabbit_Adult::m_myMate, Rabbit_Base::m_myWarren, Rabbit_Base::m_OurPopulationManager, m_pregnant, Rabbit_Warren::Mate(), rob_Male, toRabbits_Foraging, toRabbits_Gestation, and toRabbits_Lactating.

Referenced by Step().

◆ Step()

void Rabbit_Female::Step ( void )

virtual

The female rabbit step code.

The female step code is the most complicated of the rabbit behavioural control. It is very similar to the male's code but with the addition of the behaviours related to reproduction. Each day the cycle involves an evaluation of the current resource status, and then updating the reproductive behaviour. Exactly which behaviour needs to be updated depends on the current status and whether it is breeding season, and of course whether there is a mate.

Reimplemented from Rabbit_Base.

Definition at line 926 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_Foraging:
          m_CurrentRState=st_Forage();
          m_StepDone = true;
          break;
      case toRabbits_EvaluateTerritory: // Initial state always starts with develop
          m_CurrentRState=st_EvaluateTerritory();
          break;
      case toRabbits_UpdateBreedingStatus:
          m_CurrentRState=st_UpdateBreedingStatus();
          break;
      case toRabbits_Gestation:
          m_CurrentRState=st_Gestating();
          break;
      case toRabbits_GiveBirth:
          m_CurrentRState=st_GiveBirth();
          break;
      case toRabbits_Lactating:
          m_CurrentRState=st_Lactating();
          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_Female::Step()","unknown state - default");
          exit(1);
     }
 }

References Rabbit_Base::m_CurrentRState, TALMaSSObject::m_CurrentStateNo, TAnimal::m_OurLandscape, TALMaSSObject::m_StepDone, st_Dying(), st_EvaluateTerritory(), st_Forage(), st_Gestating(), st_GiveBirth(), st_Lactating(), st_UpdateBreedingStatus(), toRabbits_Die, toRabbits_EvaluateTerritory, toRabbits_Foraging, toRabbits_Gestation, toRabbits_GiveBirth, toRabbits_InitialState, toRabbits_Lactating, toRabbits_Remove, toRabbits_UpdateBreedingStatus, and Landscape::Warn().

◆ Weaned()

void Rabbit_Female::Weaned ( Rabbit_Young * a_young )

Message on weaning of a young.

If a young has been weaned then it is removed from the litter list. If it is the last one, then lactation is stopped immediately.

Definition at line 1317 of file Rabbit.cpp.

 {
     for(int l=0; l<m_myLitterSize; l++) 
     {
         if (m_myLitter[l] == a_young)
         {
             for (int n=l; n<m_myLitterSize; n++)
             {
                 m_myLitter[n] = m_myLitter[n+1];
             }
             m_myLitter[--m_myLitterSize] = NULL;
             if (m_myLitterSize == 0) m_lactating = false;
             return;
         }
     }
     // If we get here there is an error
     m_OurLandscape->Warn("Rabbit_Female::Weaned","unknown litter member");
     exit(1);
 }

References m_lactating, m_myLitter, m_myLitterSize, TAnimal::m_OurLandscape, and Landscape::Warn().

Referenced by Rabbit_Young::st_BecomeJuvenile().

Member Data Documentation

◆ m_AnnualLitters

vector<int> Rabbit_Female::m_AnnualLitters

protected

The number of litters produced.

Definition at line 507 of file Rabbit.h.

Referenced by GetLittersThisYear(), st_EvaluateTerritory(), and st_GiveBirth().

◆ m_gestationcounter

int Rabbit_Female::m_gestationcounter

protected

Counter to record the number of days gestating.

Definition at line 493 of file Rabbit.h.

Referenced by GeneralEndocrineDisruptor(), Rabbit_Female(), st_Gestating(), st_GiveBirth(), and st_UpdateBreedingStatus().

◆ m_lactating

bool Rabbit_Female::m_lactating

protected

Flag to indicate lactating.

Definition at line 491 of file Rabbit.h.

Referenced by OnYoungDeath(), Rabbit_Female(), st_Gestating(), st_GiveBirth(), st_UpdateBreedingStatus(), and Weaned().

◆ m_MaxKitsNo

double Rabbit_Female::m_MaxKitsNo = cfg_rabbitmaxkits.value() - cfg_rabbitminkits.value()

staticprotected

The maximum number of kits.

Definition at line 501 of file Rabbit.h.

Referenced by CalcLitterSize(), and SetMaxKits().

◆ m_MinKitsNo

double Rabbit_Female::m_MinKitsNo = cfg_rabbitminkits.value()

staticprotected

The minimum number of kits.

Definition at line 499 of file Rabbit.h.

Referenced by CalcLitterSize(), and SetMinKits().

◆ m_myLitter

Rabbit_Young* Rabbit_Female::m_myLitter[20]

protected

Holds the current young (for lactation)

Definition at line 495 of file Rabbit.h.

Referenced by AddYoung(), OnYoungDeath(), st_Dying(), st_GiveBirth(), st_Lactating(), and Weaned().

◆ m_myLitterSize

int Rabbit_Female::m_myLitterSize

protected

Holds the current litter size.

Definition at line 497 of file Rabbit.h.

Referenced by AddYoung(), OnYoungDeath(), Rabbit_Female(), st_Dying(), st_GiveBirth(), st_Lactating(), and Weaned().

◆ m_MyOffspring

int Rabbit_Female::m_MyOffspring

protected

The total number of kits born to her.

Definition at line 503 of file Rabbit.h.

Referenced by GetTotalOffspring(), Rabbit_Female(), and st_GiveBirth().

◆ m_MyTotalLitters

int Rabbit_Female::m_MyTotalLitters

protected

The number of litters produced.

Definition at line 505 of file Rabbit.h.

Referenced by GetTotalLitters(), Rabbit_Female(), and st_GiveBirth().

◆ m_pregnant

bool Rabbit_Female::m_pregnant

protected

Flag to indicate pregnancy.

Definition at line 489 of file Rabbit.h.

Referenced by Rabbit_Female(), st_GiveBirth(), and st_UpdateBreedingStatus().

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

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Rabbit_Female()

◆ ~Rabbit_Female()

Member Function Documentation

◆ AddYoung()

◆ CalcLitterSize()

◆ GeneralEndocrineDisruptor()

◆ GetLittersThisYear()

◆ GetTotalLitters()

◆ GetTotalOffspring()

◆ InternalPesticideHandlingAndResponse()

◆ OnYoungDeath()

◆ SetMaxKits()

◆ SetMinKits()

◆ st_Dying()

◆ st_EvaluateTerritory()

◆ st_Forage()

◆ st_Gestating()

◆ st_GiveBirth()

◆ st_Lactating()

◆ st_UpdateBreedingStatus()

◆ Step()

◆ Weaned()

Member Data Documentation

◆ m_AnnualLitters

◆ m_gestationcounter

◆ m_lactating

◆ m_MaxKitsNo

◆ m_MinKitsNo

◆ m_myLitter

◆ m_myLitterSize

◆ m_MyOffspring

◆ m_MyTotalLitters

◆ m_pregnant