Partridge_Female Class Reference

The partridge female class. More...

#include <Partridge_All.h>

Inheritance diagram for Partridge_Female:

Public Member Functions
virtual void	Dying ()
	General dying handler area. More...
virtual void	BeginStep (void)
	Female BeginStep. More...
virtual void	Step (void)
	Female Step. More...
virtual void	EndStep (void)
	Female EndStep. More...
virtual bool	DailyMortality ()
	Background mortality check. More...
virtual bool	OnFarmEvent (FarmToDo event)
	Management event handler. More...
void	OnMateDying (PartridgeCommunicationData *pc_data)
	Message handler. More...
void	OnClutchDeath ()
	Message handler. More...
void	OnClutchMown ()
	Message handler. More...
void	OnSetMyClutch (PartridgeCommunicationData *pc_data)
	Message handler. More...
void	OnChicksMatured ()
	Message handler. More...
void	OnChicksDead ()
	Message handler. More...
void	OnMating (PartridgeCommunicationData *pc_datae)
	Message handler. More...
void	OnWaitForMale ()
	Message handler. More...
void	OnEggsHatch ()
	Message handler. More...
int	GetClutchSize (void)
	´Supply clutch size More...
Partridge_Clutch *	GetClutch (void)
	Supply clutch pointer. More...
Partridge_Male *	GetMate (void)
	Supply mate pointer. More...
void	UnSetMate (void)
	Forget mate. More...
virtual bool	ArePaired ()
	Are we paired? More...
virtual void	KillThis ()
	Direct mortality message. More...
Partridge_Male *	GetOldMate (void)
	Supply old mate pointer. More...
void	SetOldMate (Partridge_Male *pm)
	Set old mate pointer. More...
void	RemoveOldMate (bool a_knockon)
	Forget old mate. More...
	Partridge_Female (int a_born_x, int a_born_y, int a_x, int a_y, Partridge_Covey *a_flock, Landscape *a_map, int a_family_counter, Partridge_Population_Manager *a_manager)
	Constructor. More...
virtual	~Partridge_Female (void)
	Destructor. More...
bool	HaveTerritory (void)
	Have we a breeding 'territory'? More...
Public Member Functions inherited from Partridge_Base
Partridge_Object	GetObjectType ()
	Supply object type. More...
bool	GetUncleStatus ()
	Supply uncle status. More...
void	SetUncleStatus (bool a_Status)
	Set uncle status. More...
bool	PossibleMate (Partridge_Base *a_partridge)
	Can we mate? More...
Partridge_Covey *	GetCovey (void)
	Supply covey pointer. More...
Partridge_State	GetState (void)
	Supply state. More...
void	SetState (Partridge_State a_pars)
	Set state. More...
int	GetFamily (void)
	Supply family ID. More...
int	GetAge (void)
	Supply age. More...
void	SetAge (int a_age)
	Set age. More...
long	GetID (void)
	Supply ID. More...
void	SetFamily (unsigned int family)
	Set family ID. More...
void	SetCovey (Partridge_Covey *a_covey)
	Set covey pointer. More...
void	MakeCovey ()
	Create our own covey. More...
void	SwitchCovey (Partridge_Covey *a_covey)
	Swap coveys. More...
	Partridge_Base (int a_born_x, int a_born_y, int a_x, int a_y, int a_family_counter, Partridge_Covey *a_covey, Landscape *a_map, Partridge_Population_Manager *a_manager)
	Constructor for Partridge_Base. More...
virtual	~Partridge_Base (void)
	Destructor. More...
virtual void	CopyMyself (int a_Ptype)
	Duplicate this object. 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	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 ()
void	CheckManagement (void)
void	CheckManagementXY (int x, int y)
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
Partridge_State	FFlocking (void)
	Female flocking state. More...
Partridge_State	FPairing (void)
	Female pairing state. More...
Partridge_State	FBuildingUpResources (void)
	Female building up resources state. More...
Partridge_State	FMakingNest (void)
	Female making nest state. More...
Partridge_State	FLaying (void)
	Female laying state. More...
Partridge_State	FStartingNewBrood (bool a_waslaying)
	Female starting new brood state. More...
Partridge_State	FIncubating (void)
	Female incubating state. More...
Partridge_State	FCaringForYoung (void)
	Female caring for young state. More...
Partridge_State	FFindingTerritory (void)
	Female finding 'territory' state. More...
Partridge_State	FAttractingMate (void)
	Female attracting mate state. More...
void	FDying (void)
virtual void	CheckMatePointers ()
	Debug function - checking mate consistency More...
double	GetNestingCoverDensity ()
	Calls Partridge_Population_Manager::GetNestingCoverDensity More...
Protected Member Functions inherited from TAnimal
void	CorrectWrapRound ()
	Corrects wrap around co-ordinate problems. More...

Protected Attributes
bool	m_HaveTerritory
	Flag for having found a suitable breeding area. More...
bool	m_clutchproduced
	Flag for having produced a clutch. More...
int	m_clutch_size
	Current clutch size. More...
int	m_clutch_number
	Current clutch attempt. More...
int	m_nest_counter
	Days spent nest building. More...
int	m_lifespan
	Physiological lifespan in days. More...
int	m_triggerlayingvar
	Adds stochasticity to the light triggering of breeding. More...
int	m_startlayingday
	Records the day laying started. More...
int	m_buildupwait
	Delay before breeding can commence. More...
Partridge_Male *	m_MyMate
	A pointer to the current mate if any. More...
Partridge_Male *	m_MyOldHusband
	A record of the previous mate if any. More...
Partridge_Clutch *	m_MyClutch
	A pointer to any current clutch. More...
Protected Attributes inherited from Partridge_Base
int	m_signal
	Used to pass information to outputs. More...
long	m_id
	Individual bird ID. More...
int	m_family_counter
	Family ID. More...
int	m_age
	Age in days. More...
int	m_born_x
	x-coord of birth More...
int	m_born_y
	y-coord of birth More...
bool	m_UncleStatus
	If has uncle status in the covey. More...
Partridge_Object	m_object_type
	Type of pob object this is. More...
Partridge_Covey *	m_covey
	Pointer to the covey. More...
Partridge_State	m_state
	Current behavioural state. 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...

Additional Inherited Members
Public Attributes inherited from Partridge_Base
Partridge_Population_Manager *	m_OurPopulationManager
	Pointer to the population manager. More...

Detailed Description

The partridge female class.

Definition at line 770 of file Partridge_All.h.

Constructor & Destructor Documentation

Partridge_Female()

Partridge_Female::Partridge_Female	(	int	a_born_x,
		int	a_born_y,
		int	a_x,
		int	a_y,
		Partridge_Covey *	a_covey,
		Landscape *	a_map,
		int	a_family_counter,
		Partridge_Population_Manager *	a_manager
	)

Constructor.

Constructor - ensures that attributes are set to sensible starting values, otherwise uses the Partridge_Base constructor.

Definition at line 1334 of file Partridge_All.cpp.

                                                                      :
     Partridge_Base( a_born_x, a_born_y, a_x, a_y, a_family_counter, a_covey, a_map, a_manager )
     {
       m_MyMate = NULL;
       m_HaveTerritory = false;
       m_object_type = pob_Female;
       m_MyOldHusband=NULL;
       m_MyClutch = NULL;
       m_clutch_size = 0;
       m_lifespan = random( cfg_par_max_lifespan.value() - cfg_par_min_lifespan.value() ) + cfg_par_min_lifespan.value();
       m_triggerlayingvar=random(cfg_par_triggerlayingvar.value());
}

References cfg_par_max_lifespan, cfg_par_min_lifespan, cfg_par_triggerlayingvar, m_clutch_size, m_HaveTerritory, m_lifespan, m_MyClutch, m_MyMate, m_MyOldHusband, Partridge_Base::m_object_type, m_triggerlayingvar, pob_Female, and CfgInt::value().

~Partridge_Female()

virtual Partridge_Female::~Partridge_Female ( void  )

inlinevirtual

Destructor.

Definition at line 917 of file Partridge_All.h.

{;}

Member Function Documentation

ArePaired()

virtual bool Partridge_Female::ArePaired ( )

inlinevirtual

Are we paired?

Reimplemented from Partridge_Base.

Definition at line 882 of file Partridge_All.h.

                             {
        if (m_MyMate!=NULL) return true;
        return false;
    }

References m_MyMate.

BeginStep()

void Partridge_Female::BeginStep ( void  )

virtual

Female BeginStep.

The BeginStep code for the female partridge. Only function is the test for mortality of different kinds. Might as well remove her here than waste CPU time thinking about the Step code later this time-step.

Reimplemented from TAnimal.

Definition at line 1354 of file Partridge_All.cpp.

{
  m_age++; // Get a day older
  if ( m_age >= m_lifespan )
  {
    m_signal = 0; // Too old
    FDying();
  }
  else if ( !DailyMortality() ) CheckManagement();
  else
  {
    m_signal = 1; // Killed
  }
#ifdef __PAR_DEBUG
  CheckMatePointers();
#endif
}

References TAnimal::CheckManagement(), CheckMatePointers(), DailyMortality(), FDying(), Partridge_Base::m_age, m_lifespan, and Partridge_Base::m_signal.

CheckMatePointers()

void Partridge_Female::CheckMatePointers ( )

protectedvirtual

Debug function - checking mate consistency

This is a debug function.

Reimplemented from Partridge_Base.

Definition at line 2827 of file Partridge_All.cpp.

{
  //**CJT** DEBUG
  if ( m_MyMate )
  {
    // Check for mutual pointers here
    if ( m_MyMate->GetMate() != this )
    {
      m_OurLandscape->Warn( "Partridge_Female::CheckMatePointers(): ""Non-mutual mate pointers", "" );
      exit( 1 );
    }
    if ( m_state == pars_FFlocking )
    {
      m_OurLandscape->Warn( "Partridge_Female::CheckMatePointers(): ""Mated & Flocking", "" );
 
      exit( 1 );
    }
    if ( m_MyMate->GetCurrentStateNo() == -1 )
    {
      m_OurLandscape->Warn( "Partridge_Female::CheckMatePointers(): ""Dead Mate", "" );
      exit( 1 );
    }
  }
}

References TALMaSSObject::GetCurrentStateNo(), Partridge_Male::GetMate(), m_MyMate, TAnimal::m_OurLandscape, Partridge_Base::m_state, pars_FFlocking, and Landscape::Warn().

Referenced by BeginStep(), FBuildingUpResources(), FFindingTerritory(), FMakingNest(), FStartingNewBrood(), and Step().

DailyMortality()

bool Partridge_Female::DailyMortality ( void  )

virtual

Background mortality check.

This method is responsible for applying a general mortality, ie not explicitly modelled. There are three periods considered, a spring mortality applied during 'territory' finding (see Partridge_Female::FFindingTerritory), a winter mortality applied daily between October and April, and the rest of the year a summer mortality. In addition there is a scaling factor (extramort) which is applied if the bird is alone. All parameter values are under user control through configuration variables.

Reimplemented from Partridge_Base.

Definition at line 1454 of file Partridge_All.cpp.

{
    bool dead = false;
    double chance = g_rand_uni();
    double extramort=1.0;
    if ( m_covey->GetCoveySize() == 1 ) {
        extramort=cfg_par_adult_mortality_alone.value();
    }
    int today = m_OurLandscape->SupplyDayInYear();
    if (m_state == pars_FFindingTerritory)  {
        if ( chance < cfg_par_adult_mortalitySpring.value()*extramort ) dead = true;
    }
    else {
        // Is it winter?
        if ( ( today >= October ) || ( today < April ) ) {
            // We are in the "Winter Period"
            if ( chance < cfg_par_adult_mortalityWinter.value()*extramort ) dead = true;
        }
        else // Not winter and not finding territory
        {
            if ( chance < (cfg_par_adult_mortalitySummer.value()*extramort) ) dead = true;
        }
    }
    if ( dead ) {
        FDying();
        return true;
    }
    return false;
}

References April, cfg_par_adult_mortality_alone, cfg_par_adult_mortalitySpring, cfg_par_adult_mortalitySummer, cfg_par_adult_mortalityWinter, FDying(), g_rand_uni, Partridge_Covey::GetCoveySize(), Partridge_Base::m_covey, TAnimal::m_OurLandscape, Partridge_Base::m_state, October, pars_FFindingTerritory, Landscape::SupplyDayInYear(), and CfgFloat::value().

Referenced by BeginStep().

Dying()

virtual void Partridge_Female::Dying ( )

inlinevirtual

General dying handler area.

Reimplemented from TAnimal.

Definition at line 827 of file Partridge_All.h.

                         {
        FDying();
    }

References FDying().

EndStep()

void Partridge_Female::EndStep ( void  )

virtual

Female EndStep.

Nothing to do.

Reimplemented from TAnimal.

Definition at line 1441 of file Partridge_All.cpp.

{
#ifdef __PAR_DEBUG
#endif
}

FAttractingMate()

Partridge_State Partridge_Female::FAttractingMate ( void  )

protected

Female attracting mate state.

This just loops because it is the male who controls this. She will stay doing this until either she is pulled out by a male arriving or give up breeding date is reached.
During this period her covey peg is locked in position following Partridge_Female::FFindingTerritory, so she cannot be moved by other covies.

Definition at line 1962 of file Partridge_All.cpp.

{
  if ( !m_OurPopulationManager->SupplyShouldFlock() )
  {
    return pars_FAttractingMate;
  }
  else
  {
    // Unlock covey 'peg'.
    m_covey->SetFixed( false );
    return pars_FFlocking;
  }
}

References Partridge_Base::m_covey, Partridge_Base::m_OurPopulationManager, pars_FAttractingMate, pars_FFlocking, Partridge_Covey::SetFixed(), and Partridge_Population_Manager::SupplyShouldFlock().

Referenced by Step().

FBuildingUpResources()

Partridge_State Partridge_Female::FBuildingUpResources ( void  )

protected

Female building up resources state.

This is simply a waiting state where we assume the female is building up physiologial resources before breeding. Since we don't know what triggers this we origianlly used a fixed counter from the point were territory has been fixed. This produced variation in the starting laying date determined by when the pair fixes their breeding territory for this season. However this did not seem satisfactory so it has been replaced with a measure of daylength with variation.

Definition at line 1644 of file Partridge_All.cpp.

{
#ifdef __PAR_DEBUG
  CheckMatePointers();
  /* if ( m_nest_counter < 1 ) { exit( 0 ); } */
#endif
    // Note that with default settings the m_buildupwait is always gong to be 0 or less on calling this method.
    if (--m_buildupwait < 0) {
        // daylength que from when they start the covey dissolve
        // This could be altered to include bad weather delays
        if ( m_OurLandscape->SupplyDaylength() >= (cfg_par_triggerlaying.value()+m_triggerlayingvar) )
        {
            m_nest_counter = cfg_par_days_to_make_nest.value();
            return pars_FMakingNest;
        }
    }
    return pars_FBuildingUpResources;
}

References cfg_par_days_to_make_nest, cfg_par_triggerlaying, CheckMatePointers(), m_buildupwait, m_nest_counter, TAnimal::m_OurLandscape, m_triggerlayingvar, pars_FBuildingUpResources, pars_FMakingNest, Landscape::SupplyDaylength(), and CfgInt::value().

Referenced by Step().

FCaringForYoung()

Partridge_State Partridge_Female::FCaringForYoung ( void  )

protected

Female caring for young state.

Will stay in this state until her young counter is zero - this is caused by messages from the young, so nothing to do but wait. Distance move is calculated as a function of chick food needs, so uses chick age.

Definition at line 1896 of file Partridge_All.cpp.

{
  int ch_age = m_covey->GetChickAge();
  m_covey->MoveDistance( g_MaxWalk[ch_age], 10, 10000 );
  return pars_FCaringForYoung;
}

References g_MaxWalk, Partridge_Covey::GetChickAge(), Partridge_Base::m_covey, Partridge_Covey::MoveDistance(), and pars_FCaringForYoung.

Referenced by Step().

FDying()

void Partridge_Female::FDying ( void  )

protected

Must do all the clean-up necessary to remove the female from the simulation without leaving any stray pointers to this object.

Definition at line 1984 of file Partridge_All.cpp.

{
  if ( m_CurrentStateNo == -1 ) return; // Don't kill me twice
  // Do I have kids? - dont' care - taken care of by covey
  // Do I have a clutch & mate, if so tell them
  m_OurPopulationManager->m_comms_data->m_female = this;
  m_OurPopulationManager->m_comms_data->m_male = m_MyMate;
  m_OurPopulationManager->m_comms_data->m_clutch = m_MyClutch;
  m_OurPopulationManager->m_messagecentre.PassMessage( m_OurPopulationManager->m_comms_data, pcomm_MumDeadC );
  m_MyMate = NULL;
  RemoveOldMate(false);
  m_CurrentStateNo = -1;
  m_StepDone = true;
  m_covey->NestLeave(); // Just in case this is not already done
  m_covey->RemoveMember( this );
  m_state = pars_Destroy;
  // Output as necessary
  m_OurPopulationManager->m_Ourkfactors->m_ThisYear->incNoDeadFemales();
  //m_covey->SanityCheck2(m_covey->GetOurChicks() );
  //  m_OurPopulationManager->WriteParAdMort( m_OurLandscape->SupplyGlobalDate(), m_age, 1, m_signal );
}

References population_attributes::incNoDeadFemales(), PartridgeCommunicationData::m_clutch, Partridge_Population_Manager::m_comms_data, Partridge_Base::m_covey, TALMaSSObject::m_CurrentStateNo, PartridgeCommunicationData::m_female, PartridgeCommunicationData::m_male, Partridge_Population_Manager::m_messagecentre, m_MyClutch, m_MyMate, Partridge_Population_Manager::m_Ourkfactors, Partridge_Base::m_OurPopulationManager, Partridge_Base::m_state, TALMaSSObject::m_StepDone, k_factors::m_ThisYear, Partridge_Covey::NestLeave(), pars_Destroy, Partridge_Communication::PassMessage(), pcomm_MumDeadC, Partridge_Covey::RemoveMember(), and RemoveOldMate().

Referenced by BeginStep(), DailyMortality(), Dying(), FIncubating(), KillThis(), OnClutchMown(), and OnFarmEvent().

FFindingTerritory()

Partridge_State Partridge_Female::FFindingTerritory ( void  )

protected

Female finding 'territory' state.

Territory here is used to mean a place where breeding is possible and not a territory in the normal definition of a defended area.

First we have to be sure we are not too late in the year, if so start flocking.
Next we make a movement using Partridge_Covey::FlyTo and determine the quality of the territory compared to a minimum acceptable quality.
Next we check whether this area is already occupied by a covey. If this is OK then we settle here. If we fail at any of these steps then we have 49 more tries in this time-step before giving up until the next day.

Definition at line 1912 of file Partridge_All.cpp.

{
    // First check that we are not too late in the year
    if ( m_OurPopulationManager->SupplyShouldFlock() )  {
        if ( m_MyMate ) {
          m_OurPopulationManager->m_comms_data->m_female = this;
          m_OurPopulationManager->m_comms_data->m_male = m_MyMate;
          m_OurPopulationManager->m_messagecentre.PassMessage( m_OurPopulationManager->m_comms_data, pcomm_FemaleGivingUp );
          m_MyMate = NULL;
        }
        m_covey->SetFixed( false ); // ensure we do not have a fixed territory loc
        return pars_FFlocking;
    }
    int steps = 0;
    do  {
        if (m_covey->FlyTo( random( cfg_par_female_movement_max.value() ) )) {
            // OK so ask the covey about quality here
            double q = m_covey->AssessHabitatQualityFaster();
            int today = m_OurLandscape->SupplyDayInYear();
            int dayspast = today - cfg_par_start_dissolve.value(); // start day as soon as covey dissolve starts to happen
            double terr_score = m_OurPopulationManager->GetHabitatQuality(dayspast);
            // Test whether the score is above the minimum quality required.
            if ( q > terr_score )
            {
                // Is the covey too close to another, therefore this location is unsuitable?
                if ( !m_covey->TooClose() ) {
                    m_HaveTerritory = true;
                    m_covey->FixHabitat();
                    m_covey->SetFixed( true ); // Can read this with IsFixed()
        #ifdef __PAR_DEBUG
                CheckMatePointers();
        #endif
                    m_clutch_number = 0;
                    if ( !m_MyMate ) return pars_FAttractingMate;
                    else {
                        // No need to tell the male, he will check the m_HaveTerritory flag
                        m_buildupwait = cfg_buildupwait.value();
                        return pars_FBuildingUpResources;
                    }
                }
            }
        }
    } while ( ++steps < 50 ); // this many goes per day
    m_HaveTerritory = false;
    // try again tomorrow
    return pars_FFindingTerritory;
}

References Partridge_Covey::AssessHabitatQualityFaster(), cfg_buildupwait, cfg_par_female_movement_max, cfg_par_start_dissolve, CheckMatePointers(), Partridge_Covey::FixHabitat(), Partridge_Covey::FlyTo(), Partridge_Population_Manager::GetHabitatQuality(), m_buildupwait, m_clutch_number, Partridge_Population_Manager::m_comms_data, Partridge_Base::m_covey, PartridgeCommunicationData::m_female, m_HaveTerritory, PartridgeCommunicationData::m_male, Partridge_Population_Manager::m_messagecentre, m_MyMate, TAnimal::m_OurLandscape, Partridge_Base::m_OurPopulationManager, pars_FAttractingMate, pars_FBuildingUpResources, pars_FFindingTerritory, pars_FFlocking, Partridge_Communication::PassMessage(), pcomm_FemaleGivingUp, Partridge_Covey::SetFixed(), Landscape::SupplyDayInYear(), Partridge_Population_Manager::SupplyShouldFlock(), Partridge_Covey::TooClose(), and CfgInt::value().

Referenced by Step().

FFlocking()

Partridge_State Partridge_Female::FFlocking ( void  )

protected

Female flocking state.

Ensures that the covey is moving around while flocking. NB: It is OK for all the members of the covey to call this method every day. It only has any effect on the first call.
The birds wait in this state until they get a message initiating breeding behaviour.

Definition at line 1632 of file Partridge_All.cpp.

{
  m_covey->MoveDistance( m_covey->GetmaxAllowedMove(), 10, m_covey->GetmaxFoodNeedToday() );
  return pars_FFlocking;
}

References Partridge_Covey::GetmaxAllowedMove(), Partridge_Covey::GetmaxFoodNeedToday(), Partridge_Base::m_covey, Partridge_Covey::MoveDistance(), and pars_FFlocking.

Referenced by Step().

FIncubating()

Partridge_State Partridge_Female::FIncubating ( void  )

protected

Female incubating state.

Arrives here from Laying, and stays until either the clutch tells her its hatched, or the clutch is dead - so just wait unless eaten via density-dependent mortality depending upon the number of nests nearby. NB this is a local density-dependence.

Definition at line 1856 of file Partridge_All.cpp.

{
  if ( g_rand_uni() < cfg_par_clutch_mortality.value() )
  { // only the eggs
    m_OurPopulationManager->m_Ourkfactors->m_ThisYear->incNoClutchesPredated();
    m_OurPopulationManager->m_comms_data->m_female = this;
    m_OurPopulationManager->m_comms_data->m_clutch = m_MyClutch;
    m_OurPopulationManager->m_messagecentre.PassMessage( m_OurPopulationManager->m_comms_data, pcomm_ClutchEaten );
    m_covey->NestLeave();
    m_state = FStartingNewBrood( false );
    m_MyClutch = NULL;
    return m_state;
  }
  // Only need to calculate the heavy bit if the nest survives egg predation
  double dens = 0.000001 + m_OurPopulationManager->ClutchDensity( m_covey->X(), m_covey->Y(), 500 );
  // Have use DPotts idea as the basis but modified this to account for the local rather than global density.
  double todaysmortchance = cfg_par_female_incubation_mortality_const.value()
       - ( pow( (double) dens, (double) cfg_par_female_incubation_mortality_slope.value() ) );
  todaysmortchance *= 100000;
  if ( random( 100000 ) < todaysmortchance )
  {
    // both eaten
    FDying();
    // Register the death with k_factors
    m_OurPopulationManager->m_Ourkfactors->m_ThisYear->incNoHensPredated();
    m_OurPopulationManager->m_Ourkfactors->m_ThisYear->incNoClutchesPredated();
    m_covey->NestLeave();
    return pars_FDying; // This does nothing actually
  }
  return pars_FIncubating;
}

References cfg_par_clutch_mortality, cfg_par_female_incubation_mortality_const, cfg_par_female_incubation_mortality_slope, Partridge_Population_Manager::ClutchDensity(), FDying(), FStartingNewBrood(), g_rand_uni, population_attributes::incNoClutchesPredated(), population_attributes::incNoHensPredated(), PartridgeCommunicationData::m_clutch, Partridge_Population_Manager::m_comms_data, Partridge_Base::m_covey, PartridgeCommunicationData::m_female, Partridge_Population_Manager::m_messagecentre, m_MyClutch, Partridge_Population_Manager::m_Ourkfactors, Partridge_Base::m_OurPopulationManager, Partridge_Base::m_state, k_factors::m_ThisYear, Partridge_Covey::NestLeave(), pars_FDying, pars_FIncubating, Partridge_Communication::PassMessage(), pcomm_ClutchEaten, CfgFloat::value(), Partridge_Covey::X(), and Partridge_Covey::Y().

Referenced by Step().

FLaying()

Partridge_State Partridge_Female::FLaying ( void  )

protected

Female laying state.

Need to add eggs to clutch, here the problem is that eggs are not produced one each day We have: cfg_par_days_per_egg.value() and m_clutch_size and m_startlayingday so we just add one egg each cfg_par_days_per_egg.value() days until we have the size wee need.
If she completes her laying this is counted as a success and the female remembers the male as a good mate and makes a transition to FIncubating.

Definition at line 1768 of file Partridge_All.cpp.

{
    // 24th Jan 2008 CJT added the code below to allow for clutch predation before clutch completion
    if ( g_rand_uni() < cfg_par_clutch_mortality.value() ) { // only the eggs
        m_OurPopulationManager->m_Ourkfactors->m_ThisYear->incNoClutchesPredated();
        m_OurPopulationManager->m_comms_data->m_female = this;
        m_OurPopulationManager->m_comms_data->m_clutch = m_MyClutch;
        m_OurPopulationManager->m_messagecentre.PassMessage( m_OurPopulationManager->m_comms_data, pcomm_ClutchEaten );
        m_covey->NestLeave(); // Should not strictly be necessary, but safe
        m_state = FStartingNewBrood( true );
        m_MyClutch = NULL;
        return m_state;
    }
    int days = m_OurLandscape->SupplyDayInYear()-m_startlayingday;
    int cs = (int) (days / cfg_par_days_per_egg.value());
    m_MyClutch->SetClutchSize(cs);
    if (cs<m_clutch_size) return pars_FLaying;
    else {
        // Remember this male as a good mate
        SetOldMate(m_MyMate);
        m_MyMate->SetOldMate(this);
        m_MyClutch->OnStartIncubating();
        m_OurPopulationManager->WriteParClutches( m_OurLandscape->SupplyGlobalDate(), m_clutch_size, m_clutch_number );
        return pars_FIncubating;
   }
}

References cfg_par_clutch_mortality, cfg_par_days_per_egg, FStartingNewBrood(), g_rand_uni, population_attributes::incNoClutchesPredated(), PartridgeCommunicationData::m_clutch, m_clutch_number, m_clutch_size, Partridge_Population_Manager::m_comms_data, Partridge_Base::m_covey, PartridgeCommunicationData::m_female, Partridge_Population_Manager::m_messagecentre, m_MyClutch, m_MyMate, Partridge_Population_Manager::m_Ourkfactors, TAnimal::m_OurLandscape, Partridge_Base::m_OurPopulationManager, m_startlayingday, Partridge_Base::m_state, k_factors::m_ThisYear, Partridge_Covey::NestLeave(), Partridge_Clutch::OnStartIncubating(), pars_FIncubating, pars_FLaying, Partridge_Communication::PassMessage(), pcomm_ClutchEaten, Partridge_Clutch::SetClutchSize(), Partridge_Male::SetOldMate(), SetOldMate(), Landscape::SupplyDayInYear(), Landscape::SupplyGlobalDate(), CfgFloat::value(), and Partridge_Population_Manager::WriteParClutches().

Referenced by Step().

FMakingNest()

Partridge_State Partridge_Female::FMakingNest ( void  )

protected

Female making nest state.

We start with a test for the end of the breeding season. If it is not too late then we determine the eventual size of the clutch here and create this when the nest is completed. The clutch object is created with zero eggs and the eggs are added in Partridge_Female::FLaying.
Determining the number of eggs to be produced has been done by fitting a curve to Danish data from 1953 since we do not know how to do this mechanistically:

Clutch size with fitted curve used to create a probability distribution hard-coded below. This distribution is scaled up and down to obtain the correct mean clutch size recorded when parameter fitting.
The male will just carry on guarding so no need to tell him when the nest is complete. Originally needed to do a special calculation here to calculate the km nesting cover/km2 present. This does not change during the nest's existence so no danger of errors there and this code was slow so an alternative was to calculate all possible values on a coarser grid at start of simulation, then store these - this is the current implementation.

Definition at line 1673 of file Partridge_All.cpp.

{
  //
      if ( m_OurLandscape->SupplyDayInYear() >= cfg_par_last_brood_date.value() )
      {
        if ( m_MyMate )
        {
          m_OurPopulationManager->m_comms_data->m_female = this;
          m_OurPopulationManager->m_comms_data->m_male = m_MyMate;
          m_OurPopulationManager->m_messagecentre.PassMessage( m_OurPopulationManager->m_comms_data, pcomm_StoppingBreeding );
        }
        // No success so clear the oldmate
        RemoveOldMate(false);
        m_MyMate = NULL;
        m_covey->SetFixed( false );
        m_HaveTerritory = false;
        return pars_FFlocking;
      }
  // data
  const int clutchsize[19] =
  {
    // This array holds the probabilities of clutch sizes in 20 categories.
    // below from Damerham
      143, 385, 725, 1163, 1700, 2336, 3070, 3902, 4833, 5863, 6990, 8217, 9037, 9607, 9928, 10000, 10000, 10000
    // The data below is from fitting a 3rd order polynomial to the Danish Paludan 1953 for Danish conditions
    // 48, 198, 451, 807, 1266, 1828, 2493, 3261, 4132, 5106, 6182, 7361, 8416, 9208, 9736, 10000, 10000, 10000
  };
  if ( --m_nest_counter == 0 )  {
    if ( m_clutch_size == 0 )
    { // If it is not zero it must be 2nd brood and is already set so don't alter it
      int chance = random( 10000 );
      for ( int i = 0; i < 19; i++ )
      {
        if ( clutchsize[i] > chance )
        {
          m_clutch_size = cfg_par_min_no_eggs.value() + i;
          break;
        }
      }
    }
#ifdef __PAR_DEBUG
    CheckMatePointers();
    if ( m_OurLandscape->SupplyDayInYear() > 200 )
    {
      int rubbish = 0;
    }
#endif
    // NOW MAKE THE NEST
    // Find and move to a nest location
    bool fnd = m_covey->NestFindLocation();
    if ( !fnd )
    {
      // No nest site - no breeding here
      // so find another territory
      // Tell the male too
      if ( m_MyMate )
      {
        m_OurPopulationManager->m_comms_data->m_female = this;
        m_OurPopulationManager->m_comms_data->m_male = m_MyMate;
        m_OurPopulationManager->m_messagecentre.PassMessage( m_OurPopulationManager->m_comms_data, pcomm_MovingHome );
      }
      return pars_FFindingTerritory;
    }
    unsigned int family = m_family_counter + 1;
    // Make a clutch object
    Clutch_struct * ac;
    ac = new Clutch_struct;
    ac->x = m_Location_x;
    ac->y = m_Location_y;
    ac->bx = m_Location_x;
    ac->by = m_Location_y;
    ac->Mum = this;
    ac->No = 1; // Was clutch size but 24/01/08 the nest is built first then slowly filled. // m_clutch_size;
    ac->family_counter = family;
    ac->m_covey = m_covey;
    m_OurPopulationManager->CreateObjects( pob_Clutch, ac, 1 );
    delete ac;
    if ( m_clutchproduced )
    {
      // This must be a re-lay, so don't count it towards total clutches laid
      m_OurPopulationManager->m_Ourkfactors->m_ThisYear->decNoClutches();
    }
    m_clutchproduced = true;
    m_startlayingday = m_OurLandscape->SupplyDayInYear();
    return pars_FLaying;
  }
  return pars_FMakingNest;
}

References Partridge_struct::bx, Partridge_struct::by, cfg_par_last_brood_date, cfg_par_min_no_eggs, CheckMatePointers(), Partridge_Population_Manager::CreateObjects(), population_attributes::decNoClutches(), Partridge_struct::family_counter, m_clutch_size, m_clutchproduced, Partridge_Population_Manager::m_comms_data, Partridge_struct::m_covey, Partridge_Base::m_covey, Partridge_Base::m_family_counter, PartridgeCommunicationData::m_female, m_HaveTerritory, TAnimal::m_Location_x, TAnimal::m_Location_y, PartridgeCommunicationData::m_male, Partridge_Population_Manager::m_messagecentre, m_MyMate, m_nest_counter, Partridge_Population_Manager::m_Ourkfactors, TAnimal::m_OurLandscape, Partridge_Base::m_OurPopulationManager, m_startlayingday, k_factors::m_ThisYear, Clutch_struct::Mum, Partridge_Covey::NestFindLocation(), Clutch_struct::No, pars_FFindingTerritory, pars_FFlocking, pars_FLaying, pars_FMakingNest, Partridge_Communication::PassMessage(), pcomm_MovingHome, pcomm_StoppingBreeding, pob_Clutch, RemoveOldMate(), Partridge_Covey::SetFixed(), Landscape::SupplyDayInYear(), CfgInt::value(), Partridge_struct::x, and Partridge_struct::y.

Referenced by Step().

FPairing()

Partridge_State Partridge_Female::FPairing ( void  )

protected

Female pairing state.

FStartingNewBrood()

Partridge_State Partridge_Female::FStartingNewBrood ( bool  a_waslaying )

protected

Female starting new brood state.

Need to test whether or not to start again.
If it is a brood that is lost then this behaviour is not an option, otherwise we will end here on the loss of a clutch or nest. The data in the lines below needs to be checked if it describes the distribution of 2nd brood sizes. Currently it is the same as 1st clutch minus 4.
See also Partridge_Female::MakingNest

Definition at line 1802 of file Partridge_All.cpp.

{
    m_clutch_number++;
    const int clutchsize[19] =
    {
    // This array holds the probabilities of clutch sizes in 20 categories.
    // below from Damerham
      143, 385, 725, 1163, 1700, 2336, 3070, 3902, 4833, 5863, 6990, 8217, 9037, 9607, 9928, 10000, 10000, 10000
    // The data below is from fitting a 3rd order polynomial to the Danish Paludan 1953 for Danish conditions
    // 48, 198, 451, 807, 1266, 1828, 2493, 3261, 4132, 5106, 6182, 7361, 8416, 9208, 9736, 10000, 10000, 10000
    };
    int today = m_OurLandscape->SupplyDayInYear();
    if ( (cfg_par_last_brood_date.value() >= today ) && (m_clutch_number<2)) {
        int chance = random( 10000 );
        for ( int i = 0; i < 19; i++ ) {
            if ( clutchsize[i] > chance ) {
            m_clutch_size = cfg_par_min_no_eggs.value() + i - 4; // Subtract 4 to match with UK data for second clutches
            break;
        }
    }
    if (!a_waslaying) {
        m_nest_counter = 10; // 10 days refraction period (Aebishcher & Potts - loose idea but implemented for want of hard data )
    } else m_nest_counter = 1;
    return pars_FMakingNest; // Inlcudes finding nest location
  }
  else  {
      // Too late or too many attempts
#ifdef __PAR_DEBUG
    CheckMatePointers();
    if ( m_OurLandscape->SupplyDayInYear() < 30 )
    {
      m_OurLandscape->Warn( "Partridge_Female::FSTartingNewBrood", "Too early" );
      exit( 1 );
    }
#endif
    // tell the male we are giving up
    if ( m_MyMate != NULL )
    {
      m_OurPopulationManager->m_comms_data->m_female = this;
      m_OurPopulationManager->m_comms_data->m_male = m_MyMate;
      m_OurPopulationManager->m_messagecentre.PassMessage( m_OurPopulationManager->m_comms_data, pcomm_StoppingBreeding );
    }
    m_HaveTerritory = false;
    m_MyMate = NULL;
    m_covey->SetFixed( false );
    return pars_FFlocking;
  }
}

References cfg_par_last_brood_date, cfg_par_min_no_eggs, CheckMatePointers(), m_clutch_number, m_clutch_size, Partridge_Population_Manager::m_comms_data, Partridge_Base::m_covey, PartridgeCommunicationData::m_female, m_HaveTerritory, PartridgeCommunicationData::m_male, Partridge_Population_Manager::m_messagecentre, m_MyMate, m_nest_counter, TAnimal::m_OurLandscape, Partridge_Base::m_OurPopulationManager, pars_FFlocking, pars_FMakingNest, Partridge_Communication::PassMessage(), pcomm_StoppingBreeding, Partridge_Covey::SetFixed(), Landscape::SupplyDayInYear(), CfgInt::value(), and Landscape::Warn().

Referenced by FIncubating(), FLaying(), OnClutchDeath(), and Step().

GetClutch()

Partridge_Clutch* Partridge_Female::GetClutch ( void  )

inline

Supply clutch pointer.

Definition at line 867 of file Partridge_All.h.

                                         {
        return m_MyClutch;
    }

References m_MyClutch.

Referenced by Partridge_Communication::PassMessage().

GetClutchSize()

int Partridge_Female::GetClutchSize ( void  )

inline

´Supply clutch size

Definition at line 862 of file Partridge_All.h.

                              {
        return m_clutch_size;
    }

References m_clutch_size.

GetMate()

Partridge_Male* Partridge_Female::GetMate ( void  )

inline

Supply mate pointer.

Definition at line 872 of file Partridge_All.h.

                                     {
        return m_MyMate;
    }

References m_MyMate.

Referenced by Partridge_Covey::ArePaired(), Partridge_Male::CheckMatePointers(), Partridge_Clutch::ClDeveloping(), Partridge_Covey::FindMeAMateInCovey(), Partridge_Covey::FindMeAWife(), Partridge_Covey::OnAddChick(), and Partridge_Communication::PassMessage().

GetNestingCoverDensity()

double Partridge_Female::GetNestingCoverDensity ( )

protected

Calls Partridge_Population_Manager::GetNestingCoverDensity

Definition at line 273 of file Partridge_All.cpp.

{
  return m_OurPopulationManager->GetNestingCoverDensity( m_Location_x, m_Location_y );
}

References Partridge_Population_Manager::GetNestingCoverDensity(), TAnimal::m_Location_x, TAnimal::m_Location_y, and Partridge_Base::m_OurPopulationManager.

GetOldMate()

Partridge_Male* Partridge_Female::GetOldMate ( void  )

inline

Supply old mate pointer.

Definition at line 893 of file Partridge_All.h.

                                        {
        return m_MyOldHusband;
    }

References m_MyOldHusband.

Referenced by Partridge_Population_Manager::DissolveCovey(), Partridge_Covey::GetUnpairedFemale(), and Partridge_Communication::PassMessage().

HaveTerritory()

bool Partridge_Female::HaveTerritory ( void  )

inline

Have we a breeding 'territory'?

Definition at line 920 of file Partridge_All.h.

                               {
        return m_HaveTerritory;
    }

References m_HaveTerritory.

Referenced by Partridge_Male::MFindingMate(), Partridge_Male::MFollowingMate(), Partridge_Male::MPairing(), and OnMating().

KillThis()

virtual void Partridge_Female::KillThis ( )

inlinevirtual

Direct mortality message.

Reimplemented from TAnimal.

Definition at line 888 of file Partridge_All.h.

                            {
        FDying();
    }

References FDying().

Referenced by Partridge_Population_Manager::DoFirst().

OnChicksDead()

void Partridge_Female::OnChicksDead

(

void

)

Message handler.

Response to pcomm_AllChicksDead message arriving when the last chick dies.

Definition at line 2118 of file Partridge_All.cpp.

{
  m_state = pars_FFlocking;
  m_HaveTerritory = false;
  m_MyMate = NULL;
}

References m_HaveTerritory, m_MyMate, Partridge_Base::m_state, and pars_FFlocking.

Referenced by Partridge_Communication::PassMessage().

OnChicksMatured()

void Partridge_Female::OnChicksMatured

(

void

)

Message handler.

Response to pcomm_ChicksMature message arriving when the last chick matures.

Definition at line 2107 of file Partridge_All.cpp.

{
  m_state = pars_FFlocking;
  m_MyMate = NULL;
  m_HaveTerritory = false;
}

References m_HaveTerritory, m_MyMate, Partridge_Base::m_state, and pars_FFlocking.

Referenced by Partridge_Communication::PassMessage().

OnClutchDeath()

void Partridge_Female::OnClutchDeath

(

)

Message handler.

Arrives here follwing a pcomm_ClutchDead or a pcomm_AllInfertile message.

Definition at line 2056 of file Partridge_All.cpp.

{
    if (m_state == pars_FIncubating) {
        m_state = FStartingNewBrood(false);
    } else m_state = FStartingNewBrood(true);
    m_covey->NestLeave();
    m_MyClutch = NULL;
}

References FStartingNewBrood(), Partridge_Base::m_covey, m_MyClutch, Partridge_Base::m_state, Partridge_Covey::NestLeave(), and pars_FIncubating.

Referenced by OnClutchMown(), and Partridge_Communication::PassMessage().

OnClutchMown()

void Partridge_Female::OnClutchMown

(

)

Message handler.

Arrives here as a result of a pcomm_ClutchMown message. This determines whether the female dies with the clutch.

Definition at line 2069 of file Partridge_All.cpp.

{
    if (m_state==pars_FIncubating) {
        if ( g_rand_uni() < cfg_female_mowing_chance.value() )
        {
            //Optional output - can depend on the definition of predation in use.
            //m_OurPopulationManager->m_Ourkfactors->incNoHensPredated();
            FDying();
        }
    }
    OnClutchDeath();
}

References cfg_female_mowing_chance, FDying(), g_rand_uni, Partridge_Base::m_state, OnClutchDeath(), pars_FIncubating, and CfgFloat::value().

Referenced by Partridge_Communication::PassMessage().

OnEggsHatch()

void Partridge_Female::OnEggsHatch

(

)

Message handler.

Response to pcomm_EggsHatch message arriving on clutch hatching.

Definition at line 2096 of file Partridge_All.cpp.

{
  m_state = pars_FCaringForYoung;
  m_covey->NestLeave();
  m_MyClutch = NULL;
}

References Partridge_Base::m_covey, m_MyClutch, Partridge_Base::m_state, Partridge_Covey::NestLeave(), and pars_FCaringForYoung.

Referenced by Partridge_Communication::PassMessage().

OnFarmEvent()

bool Partridge_Female::OnFarmEvent ( FarmToDo  event )

virtual

Management event handler.

There are only a few management events that cause direct effects for the female, but these may be important eg mowing/cutting events. When she is on the nest mortaltiy is controlled via the Partridge_Clutch object not this code, since she is assumed not to escape so easily (see Partridge_Clutch::AgDying).

Reimplemented from TAnimal.

Definition at line 1491 of file Partridge_All.cpp.

{
  switch ( event )
  {
    case sleep_all_day:
    break;
    case autumn_plough:
    break;
    case autumn_harrow:
    break;
    case autumn_roll:
    break;
    case autumn_sow:
    break;
    case winter_plough:
    break;
    case deep_ploughing:
    break;
    case spring_plough:
    break;
    case spring_harrow:
    break;
    case spring_roll:
    break;
 
    case spring_sow:
    break;
    case fp_npks:
    break;
    case fp_npk:
    break;
    case fp_pk:
    break;
    case fp_liquidNH3:
    break;
    case fp_slurry:
    break;
    case fp_manganesesulphate:
    break;
    case fp_manure:
    break;
    case fp_greenmanure:
    break;
    case fp_sludge:
    break;
    case fa_npk:
    break;
    case fa_pk:
    break;
    case fa_slurry:
    break;
    case fa_ammoniumsulphate:
    break;
    case fa_manure:
    break;
    case fa_greenmanure:
    break;
    case fa_sludge:
    break;
    case glyphosate:
    case herbicide_treat:
    break;
    case growth_regulator:
    break;
    case fungicide_treat:
    break;
    case syninsecticide_treat:
    case insecticide_treat:
    case product_treat:
    break;
    case molluscicide:
    break;
    case row_cultivation:
    break;
    case strigling:
      if ( g_rand_uni() < cfg_par_ad_cut.value() ) FDying();
    break;
    case hilling_up:
    break;
    case water:
    break;
    case swathing:
    break;
    case harvest:
      if ( g_rand_uni() < cfg_par_ad_cut.value() ) FDying();
    break;
    case cattle_out:
    break;
    case cattle_out_low:
    break;
    case cut_to_hay:
      if ( g_rand_uni() < cfg_par_ad_cut.value() ) FDying();
    break;
    case cut_to_silage:
      if ( g_rand_uni() < cfg_par_ad_cut.value() ) FDying();
    break;
    case straw_chopping:
    break;
    case hay_turning:
    break;
    case hay_bailing:
      if ( g_rand_uni() < cfg_par_ad_cut.value() ) FDying();
    break;
    case stubble_harrowing:
    break;
    case autumn_or_spring_plough:
    break;
    case burn_straw_stubble:
    break;
    case mow:
      if ( g_rand_uni() < cfg_par_ad_cut.value() ) FDying();
    break;
    case cut_weeds:
      if ( g_rand_uni() < cfg_par_ad_cut.value() ) FDying();
    break;
    case pigs_out:
    break;
    case strigling_sow:
      if ( g_rand_uni() < cfg_par_ad_cut.value() ) FDying();
    break;
    default:
      m_OurLandscape->Warn( "Partridge_Female::OnFarmEvent(): Unknown event type:",
           m_OurLandscape->EventtypeToString( event ) );
      exit( 1 );
  }
  // Must incorporate a test here in case the animal is dead - killing it twice
  // can be a bad idea
  if ( m_state == pars_Destroy ) return true;
  else
    return false;
}

References autumn_harrow, autumn_or_spring_plough, autumn_plough, autumn_roll, autumn_sow, burn_straw_stubble, cattle_out, cattle_out_low, cfg_par_ad_cut, cut_to_hay, cut_to_silage, cut_weeds, deep_ploughing, Landscape::EventtypeToString(), fa_ammoniumsulphate, fa_greenmanure, fa_manure, fa_npk, fa_pk, fa_sludge, fa_slurry, FDying(), fp_greenmanure, fp_liquidNH3, fp_manganesesulphate, fp_manure, fp_npk, fp_npks, fp_pk, fp_sludge, fp_slurry, fungicide_treat, g_rand_uni, glyphosate, growth_regulator, harvest, hay_bailing, hay_turning, herbicide_treat, hilling_up, insecticide_treat, TAnimal::m_OurLandscape, Partridge_Base::m_state, molluscicide, mow, pars_Destroy, pigs_out, product_treat, row_cultivation, sleep_all_day, spring_harrow, spring_plough, spring_roll, spring_sow, straw_chopping, strigling, strigling_sow, stubble_harrowing, swathing, syninsecticide_treat, CfgFloat::value(), Landscape::Warn(), water, and winter_plough.

OnMateDying()

void Partridge_Female::OnMateDying

(

PartridgeCommunicationData *

pc_data

)

Message handler.

Response to a pcomm_MaleDying message from Partridge_Male::MDying.

Definition at line 2129 of file Partridge_All.cpp.

{
  if ( pc_data->m_male != m_MyMate )
  {
    m_OurLandscape->Warn( "Partridge_Female::OnMateDying(): ""m_MyMate is not the mate that is dying", "" );
    exit( 1 );
  }
  RemoveOldMate(false);
  m_MyMate = NULL;
  // What she does now depends on whether the chicks have hatched etc.
  switch ( m_state )
  {
    case pars_FCaringForYoung:
    break; // keep doing it
    case pars_FFlocking:
      m_state = pars_FFlocking;
    break;
    case pars_FFindingTerritory:
      m_state = pars_FFindingTerritory;
    break;
    case pars_FIncubating:
    case pars_FLaying:
      //break;
      m_state = pars_FFindingTerritory;
      m_MyClutch->OnGivenUp();
      m_MyClutch = NULL;
      m_covey->SetFixed( false );
      m_covey->NestLeave();
      break;
    case pars_FMakingNest:
    case pars_FBuildingUpResources:
    case pars_FStartingNewBrood:
      m_state = pars_FAttractingMate;
      m_covey->SetFixed( false );
      m_covey->NestLeave();
    break;
    default:
      m_OurLandscape->Warn( "Partridge_Female::OnMateDeath - unknown pars type", NULL );
      exit( 1 );
  }
}

References Partridge_Base::m_covey, PartridgeCommunicationData::m_male, m_MyClutch, m_MyMate, TAnimal::m_OurLandscape, Partridge_Base::m_state, Partridge_Covey::NestLeave(), Partridge_Clutch::OnGivenUp(), pars_FAttractingMate, pars_FBuildingUpResources, pars_FCaringForYoung, pars_FFindingTerritory, pars_FFlocking, pars_FIncubating, pars_FLaying, pars_FMakingNest, pars_FStartingNewBrood, RemoveOldMate(), Partridge_Covey::SetFixed(), and Landscape::Warn().

Referenced by Partridge_Communication::PassMessage().

OnMating()

void Partridge_Female::OnMating

(

PartridgeCommunicationData *

pc_data

)

Message handler.

Arrives here following pcomm_Mating message from either Partridge_Population_Manager::DissolveCovey or Partridge_Male::MFindingMate.

Definition at line 2031 of file Partridge_All.cpp.

{
  m_MyMate = pc_data->m_male;
  RemoveOldMate(false);
  SwitchCovey( pc_data->m_covey );
  // The state she needs to go to depends on she has a
  // territory or not
  if ( HaveTerritory() )
  {
    m_state = pars_FBuildingUpResources;
    m_buildupwait = cfg_buildupwait.value();
  }
  else
    m_state = pars_FFindingTerritory;
  m_clutch_number = 0;
  m_clutchproduced = false;
}

References cfg_buildupwait, HaveTerritory(), m_buildupwait, m_clutch_number, m_clutchproduced, PartridgeCommunicationData::m_covey, PartridgeCommunicationData::m_male, m_MyMate, Partridge_Base::m_state, pars_FBuildingUpResources, pars_FFindingTerritory, RemoveOldMate(), Partridge_Base::SwitchCovey(), and CfgInt::value().

Referenced by Partridge_Communication::PassMessage().

OnSetMyClutch()

void Partridge_Female::OnSetMyClutch

(

PartridgeCommunicationData *

pc_data

)

Message handler.

Response to the pcomm_SetClutch message received on Partridge_Clutch object creation.

Definition at line 2086 of file Partridge_All.cpp.

{
  m_MyClutch = pc_data->m_clutch;
  m_state = pars_FIncubating;
}

References PartridgeCommunicationData::m_clutch, m_MyClutch, Partridge_Base::m_state, and pars_FIncubating.

Referenced by Partridge_Communication::PassMessage().

OnWaitForMale()

void Partridge_Female::OnWaitForMale

(

)

Message handler.

Called following a pcomm_WaitForMale message from Partridge_Population_Manager::DissolveCovey

Definition at line 2015 of file Partridge_All.cpp.

{
  m_covey->SetFixed( false );
  if (m_UncleStatus) {
      SetUncleStatus( false );
  }
  RemoveOldMate(false);
  m_state = pars_FAttractingMate;
}

References Partridge_Base::m_covey, Partridge_Base::m_state, Partridge_Base::m_UncleStatus, pars_FAttractingMate, RemoveOldMate(), Partridge_Covey::SetFixed(), and Partridge_Base::SetUncleStatus().

Referenced by Partridge_Communication::PassMessage().

RemoveOldMate()

void Partridge_Female::RemoveOldMate ( bool  a_knockon )

inline

Forget old mate.

Definition at line 903 of file Partridge_All.h.

                                       {
        if (m_MyOldHusband!= NULL) {
            if (!a_knockon) { // if it is a knock on then don't start a recursive set of calls
                m_MyOldHusband->RemoveOldMate(true);
            }
            m_MyOldHusband= NULL;
        }
    }

References m_MyOldHusband, and Partridge_Male::RemoveOldMate().

Referenced by FDying(), FMakingNest(), Partridge_Covey::GetUnpairedFemale(), OnMateDying(), OnMating(), OnWaitForMale(), and Partridge_Male::RemoveOldMate().

SetOldMate()

void Partridge_Female::SetOldMate ( Partridge_Male *  pm )

inline

Set old mate pointer.

Definition at line 898 of file Partridge_All.h.

                                          {
        m_MyOldHusband=pm;
    }

References m_MyOldHusband.

Referenced by FLaying().

Step()

void Partridge_Female::Step ( void  )

virtual

Female Step.

The Step code for the female partridge. This is the main state-transition control for the female. It will be called repeatedly each time-step until m_StepDone is set to true.

Reimplemented from TAnimal.

Definition at line 1378 of file Partridge_All.cpp.

{
 
  if ( m_CurrentStateNo == -1 || m_StepDone )
    return;
  switch ( m_state )
  {
    case pars_Initiation:
    case pars_FFlocking:
      m_state = FFlocking();
      m_StepDone = true;
    break;
    case pars_FFindingTerritory:
      m_state = FFindingTerritory();
      m_StepDone = true;
    break;
    case pars_FAttractingMate:
      m_state = FAttractingMate();
      m_StepDone = true;
    break;
    case pars_FBuildingUpResources:
      m_state = FBuildingUpResources();
      m_StepDone = true;
    break;
    case pars_FMakingNest:
      m_state = FMakingNest();
      m_StepDone = true;
    break;
    case pars_FLaying:
      m_state = FLaying();
      m_StepDone = true;
    break;
    case pars_FStartingNewBrood:
      m_state = FStartingNewBrood( false );
      m_StepDone = true;
    break;
    case pars_FIncubating:
      m_state = FIncubating();
      m_StepDone = true;
    break;
    case pars_FCaringForYoung:
      m_state = FCaringForYoung();
      m_StepDone = true;
    break;
    case pars_FDying:
      m_StepDone = true;
    break;
    default:
      char st[255];
      sprintf(st,"%d\n",m_state);
      m_OurLandscape->Warn( "Partridge_Female::Step - unknown pars type ", st );
      exit( 1 );
  }
#ifdef __PAR_DEBUG
  CheckMatePointers();
#endif
}

References CheckMatePointers(), FAttractingMate(), FBuildingUpResources(), FCaringForYoung(), FFindingTerritory(), FFlocking(), FIncubating(), FLaying(), FMakingNest(), FStartingNewBrood(), TALMaSSObject::m_CurrentStateNo, TAnimal::m_OurLandscape, Partridge_Base::m_state, TALMaSSObject::m_StepDone, pars_FAttractingMate, pars_FBuildingUpResources, pars_FCaringForYoung, pars_FDying, pars_FFindingTerritory, pars_FFlocking, pars_FIncubating, pars_FLaying, pars_FMakingNest, pars_FStartingNewBrood, pars_Initiation, and Landscape::Warn().

UnSetMate()

void Partridge_Female::UnSetMate ( void  )

inline

Forget mate.

Definition at line 877 of file Partridge_All.h.

                           {
        m_MyMate=NULL;
    }

References m_MyMate.

Member Data Documentation

m_buildupwait

int Partridge_Female::m_buildupwait

protected

Delay before breeding can commence.

Definition at line 817 of file Partridge_All.h.

Referenced by FBuildingUpResources(), FFindingTerritory(), and OnMating().

m_clutch_number

int Partridge_Female::m_clutch_number

protected

Current clutch attempt.

Definition at line 807 of file Partridge_All.h.

Referenced by FFindingTerritory(), FLaying(), FStartingNewBrood(), and OnMating().

m_clutch_size

int Partridge_Female::m_clutch_size

protected

Current clutch size.

Definition at line 805 of file Partridge_All.h.

Referenced by FLaying(), FMakingNest(), FStartingNewBrood(), GetClutchSize(), and Partridge_Female().

m_clutchproduced

bool Partridge_Female::m_clutchproduced

protected

Flag for having produced a clutch.

Definition at line 803 of file Partridge_All.h.

Referenced by FMakingNest(), and OnMating().

m_HaveTerritory

bool Partridge_Female::m_HaveTerritory

protected

Flag for having found a suitable breeding area.

Definition at line 801 of file Partridge_All.h.

Referenced by FFindingTerritory(), FMakingNest(), FStartingNewBrood(), HaveTerritory(), OnChicksDead(), OnChicksMatured(), and Partridge_Female().

m_lifespan

int Partridge_Female::m_lifespan

protected

Physiological lifespan in days.

Definition at line 811 of file Partridge_All.h.

Referenced by BeginStep(), and Partridge_Female().

m_MyClutch

Partridge_Clutch* Partridge_Female::m_MyClutch

protected

A pointer to any current clutch.

Definition at line 823 of file Partridge_All.h.

Referenced by FDying(), FIncubating(), FLaying(), GetClutch(), OnClutchDeath(), OnEggsHatch(), OnMateDying(), OnSetMyClutch(), and Partridge_Female().

m_MyMate

Partridge_Male* Partridge_Female::m_MyMate

protected

A pointer to the current mate if any.

Definition at line 819 of file Partridge_All.h.

Referenced by ArePaired(), CheckMatePointers(), FDying(), FFindingTerritory(), FLaying(), FMakingNest(), FStartingNewBrood(), GetMate(), OnChicksDead(), OnChicksMatured(), OnMateDying(), OnMating(), Partridge_Female(), and UnSetMate().

m_MyOldHusband

Partridge_Male* Partridge_Female::m_MyOldHusband

protected

A record of the previous mate if any.

Definition at line 821 of file Partridge_All.h.

Referenced by GetOldMate(), Partridge_Female(), RemoveOldMate(), and SetOldMate().

m_nest_counter

int Partridge_Female::m_nest_counter

protected

Days spent nest building.

Definition at line 809 of file Partridge_All.h.

Referenced by FBuildingUpResources(), FMakingNest(), and FStartingNewBrood().

m_startlayingday

int Partridge_Female::m_startlayingday

protected

Records the day laying started.

Definition at line 815 of file Partridge_All.h.

Referenced by FLaying(), and FMakingNest().

m_triggerlayingvar

int Partridge_Female::m_triggerlayingvar

protected

Adds stochasticity to the light triggering of breeding.

Definition at line 813 of file Partridge_All.h.

Referenced by FBuildingUpResources(), and Partridge_Female().

---

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

• C:/Repo/ALMaSS_All/Partridge/Partridge_All.h
• C:/Repo/ALMaSS_All/Partridge/Partridge_All.cpp