Partridge_Chick Class Reference

Partridge chick class. More...

#include <Partridge_All.h>

Inheritance diagram for Partridge_Chick:

Public Member Functions
virtual void	BeginStep (void)
	Chick BeginStep. More...
virtual void	Step (void)
	Chick Step. More...
virtual void	EndStep (void)
	Chick EndStep. More...
virtual bool	DailyMortality ()
	Background mortality test. More...
virtual bool	OnFarmEvent (FarmToDo event)
	Farm event handler. More...
virtual void	Dying ()
	Generic dying handler. More...
void	OnYouAreDead ()
	Message handler. More...
	Partridge_Chick (int a_x, int a_y, Partridge_Female *a_mother, Partridge_Covey *a_flock, Landscape *a_map, bool a_sex, int a_family_counter, Partridge_Population_Manager *a_manager)
	Constructor. More...
virtual	~Partridge_Chick (void)
	Destructor. 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...
virtual bool	ArePaired ()
	Overridden base function. 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	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 ()
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
virtual Partridge_State	ChDeveloping (void)
	Development. More...
virtual Partridge_State	ChMaturing (void)
	Maturation. More...
void	ChDying (void)
	Chick Dying. More...
Protected Member Functions inherited from Partridge_Base
virtual void	CheckMatePointers ()
	Debug. More...
Protected Member Functions inherited from TAnimal
void	CorrectWrapRound ()
	Corrects wrap around co-ordinate problems. More...

Protected Attributes
bool	m_sex
	Sex. More...
int	m_starve
	Days spent starving. 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

Partridge chick class.

Definition at line 581 of file Partridge_All.h.

Constructor & Destructor Documentation

Partridge_Chick()

Partridge_Chick::Partridge_Chick	(	int	a_born_x,
		int	a_born_y,
		Partridge_Female *	a_mother,
		Partridge_Covey *	a_covey,
		Landscape *	a_map,
		bool	a_sex,
		int	a_family_counter,
		Partridge_Population_Manager *	a_manager
	)

Constructor.

The constructor. Ensures sensible values for attributes not set by the base constructor.

Definition at line 663 of file Partridge_All.cpp.

                                                                                                     :
     Partridge_Base( a_born_x, a_born_y, a_born_x, a_born_y, a_family_counter, a_covey, a_map, a_manager )
     {
       m_age = 0;
       m_starve = 0;
       m_sex = a_sex;
       m_object_type = pob_Chick;
       m_covey->OnAddChick( a_mother );
 
}

References Partridge_Base::m_age, Partridge_Base::m_covey, Partridge_Base::m_object_type, m_sex, m_starve, Partridge_Covey::OnAddChick(), and pob_Chick.

~Partridge_Chick()

virtual Partridge_Chick::~Partridge_Chick ( void  )

inlinevirtual

Destructor.

Definition at line 619 of file Partridge_All.h.

                                     {;
    }

Member Function Documentation

BeginStep()

void Partridge_Chick::BeginStep ( void  )

virtual

Chick BeginStep.

BeginStep checks for daily mortality and management events, also deals with knock-on deaths for other chicks in the covey.

Reimplemented from TAnimal.

Reimplemented in Partridge_Chick2.

Definition at line 680 of file Partridge_All.cpp.

{
  if ( m_CurrentStateNo == -1 )
  {
    return;
  }
  if ( !DailyMortality() )
  {
    CheckManagement();
    //m_covey->SanityCheck2(m_covey->GetOurChicks() );
    m_covey->SetChickAge( m_age );
    // This call is because it is OK to get multiple calls to this function
    // but it is not OK if no-one calls it!
    m_covey->MoveDistance( g_MaxWalk[m_age], 10, 10000 );
  }
  else
  {
    m_signal = 1;
    ChDying();
    // The death of this chick will impact on the others, so that their deaths are more likely
    m_covey->ChickExtraMortality();
  }
}

References ChDying(), TAnimal::CheckManagement(), Partridge_Covey::ChickExtraMortality(), DailyMortality(), g_MaxWalk, Partridge_Base::m_age, Partridge_Base::m_covey, TALMaSSObject::m_CurrentStateNo, Partridge_Base::m_signal, Partridge_Covey::MoveDistance(), and Partridge_Covey::SetChickAge().

ChDeveloping()

Partridge_State Partridge_Chick::ChDeveloping ( void  )

protectedvirtual

Development.

Chick development is simplified to developing as long as the chick is not starving for too long. This is determined by the age dependent energy needs and rainfall. This could also be augmented to cinclude temperature at a later stage.
At 42 days old the Chick becomes a Partridge_Chick2.

Reimplemented in Partridge_Chick2.

Definition at line 922 of file Partridge_All.cpp.

{
  m_age++;
  // have we eaten enough to survive?
  double food = m_covey->SupplyFoodToday();
  double ex = cfg_par_extraction_rate.value();
  food *= ex;
#ifdef __RAIN_HURTS
  if ( food > ( g_FoodNeed[m_age] * (1+( g_par_rainfactor * m_OurLandscape->SupplyRain()) ) ))
  {
    m_starve = 0;
  }
#else
  if ( food > g_FoodNeed[m_age]  )
  {
    m_starve = 0;
  }
#endif
  else if ( ++m_starve > cfg_par_starve_threshold.value() )
  {
    m_signal = 4;
    ChDying(); // Kill it now
    //m_OurPopulationManager->WriteParJuvMort(m_OurLandscape->SupplyYearNumber(),m_OurLandscape->SupplyDayInYear(),m_age,m_signal);
    m_OurPopulationManager->m_Ourkfactors->m_ThisYear->incNoStarvedChicks();
    return pars_ChDying;
  }
  if ( m_age < 42 )
  {
    return pars_ChDeveloping;
  }
  else
    return pars_ChMaturing;
}

References cfg_par_extraction_rate, cfg_par_starve_threshold, ChDying(), g_FoodNeed, g_par_rainfactor, population_attributes::incNoStarvedChicks(), Partridge_Base::m_age, Partridge_Base::m_covey, Partridge_Population_Manager::m_Ourkfactors, TAnimal::m_OurLandscape, Partridge_Base::m_OurPopulationManager, Partridge_Base::m_signal, m_starve, k_factors::m_ThisYear, pars_ChDeveloping, pars_ChDying, pars_ChMaturing, Partridge_Covey::SupplyFoodToday(), Landscape::SupplyRain(), CfgInt::value(), and CfgFloat::value().

Referenced by EndStep().

ChDying()

void Partridge_Chick::ChDying ( void  )

protected

Chick Dying.

All the housekeeping necessary to die.

Definition at line 989 of file Partridge_All.cpp.

{
  m_covey->OnChickDeath();
  m_covey->RemoveMember( this );
  m_state = pars_Destroy;
  m_CurrentStateNo = -1;
  m_StepDone = true;
  // Keep the k_factor analysis happy and uptodate
  if ( m_age > 42 )
  {
    if ( m_sex == false )
    {
      m_OurPopulationManager->m_Ourkfactors->m_ThisYear->incNoDeadFemales();
    }
    else
      m_OurPopulationManager->m_Ourkfactors->m_ThisYear->incNoDeadMales();
  }
  m_OurPopulationManager->m_Ourkfactors->m_ThisYear->incNoDeadChicks();
 
}

References population_attributes::incNoDeadChicks(), population_attributes::incNoDeadFemales(), population_attributes::incNoDeadMales(), Partridge_Base::m_age, Partridge_Base::m_covey, TALMaSSObject::m_CurrentStateNo, Partridge_Population_Manager::m_Ourkfactors, Partridge_Base::m_OurPopulationManager, m_sex, Partridge_Base::m_state, TALMaSSObject::m_StepDone, k_factors::m_ThisYear, Partridge_Covey::OnChickDeath(), pars_Destroy, and Partridge_Covey::RemoveMember().

Referenced by BeginStep(), Partridge_Chick2::BeginStep(), ChDeveloping(), Dying(), EndStep(), Partridge_Chick2::EndStep(), OnFarmEvent(), and OnYouAreDead().

ChMaturing()

Partridge_State Partridge_Chick::ChMaturing ( void  )

protectedvirtual

Maturation.

Matures the Chick object into a Partridge_Chick2 object, passing all the necessary informatin using a Chick_struct.

Reimplemented in Partridge_Chick2.

Definition at line 961 of file Partridge_All.cpp.

{
  //m_covey->SanityCheck2(m_covey->GetOurChicks() );
  Chick_struct * Ch;
  Ch = new Chick_struct;
  Ch->x = m_Location_x;
  Ch->y = m_Location_y;
  Ch->bx = m_Location_x;
  Ch->by = m_Location_y;
  Ch->Mum = NULL;
  Ch->m_covey = m_covey;
  Ch->sex = m_sex;
  Ch->family_counter = m_family_counter;
  // Create objects will result in the object being added to the covey
  m_OurPopulationManager->CreateObjects( pob_Chick2, Ch, 1 );
  // object will be destroyed by death state
  // but must let Dad know anyway
  delete Ch;
  // Set up the flags to destroy this object
  m_CurrentStateNo = -1;
  m_StepDone = true;
  m_covey->RemoveMember( this );
  //m_covey->SanityCheck2(m_covey->GetOurChicks() );
  return pars_Destroy;
}

References Partridge_struct::bx, Partridge_struct::by, Partridge_Population_Manager::CreateObjects(), Partridge_struct::family_counter, Partridge_struct::m_covey, Partridge_Base::m_covey, TALMaSSObject::m_CurrentStateNo, Partridge_Base::m_family_counter, TAnimal::m_Location_x, TAnimal::m_Location_y, Partridge_Base::m_OurPopulationManager, m_sex, TALMaSSObject::m_StepDone, Chick_struct::Mum, pars_Destroy, pob_Chick2, Partridge_Covey::RemoveMember(), Chick_struct::sex, Partridge_struct::x, and Partridge_struct::y.

Referenced by Step().

DailyMortality()

bool Partridge_Chick::DailyMortality ( void  )

virtual

Background mortality test.

Does the simple probability test against chance of daily mortality for non-specifically modelled mortalities.

Reimplemented from Partridge_Base.

Reimplemented in Partridge_Chick2.

Definition at line 905 of file Partridge_All.cpp.

{
    if ( g_rand_uni() < cfg_par_chick_mortality.value() )
    {
        // Optional output
        //    m_OurPopulationManager->AddEaten();
        return true;
    }
    return false;
}

References cfg_par_chick_mortality, g_rand_uni, and CfgFloat::value().

Referenced by BeginStep().

Dying()

virtual void Partridge_Chick::Dying ( )

inlinevirtual

Generic dying handler.

Reimplemented from TAnimal.

Definition at line 607 of file Partridge_All.h.

                         {
        ChDying();
    }

References ChDying().

Referenced by Partridge_Chick2::OnFarmEvent().

EndStep()

void Partridge_Chick::EndStep ( void  )

virtual

Chick EndStep.

EndStep does the developing for the Chick. This ensures that someone (adult) has called the methods necessary to collect food for developing that day during Step.

Reimplemented from TAnimal.

Reimplemented in Partridge_Chick2.

Definition at line 738 of file Partridge_All.cpp.

{
  if ( m_CurrentStateNo == -1 )
    return;
 
  switch ( m_state )
  {
    case pars_Initiation:
    case pars_ChMaturing:
    break;
    case pars_ChDying:
      ChDying();
    break;
    case pars_ChDeveloping:
      m_state = ChDeveloping();
    break;
    default:
      m_OurLandscape->Warn( "Partridge_Chick::EndStep - unknown pars type", NULL );
      exit( 1 );
  }
}

References ChDeveloping(), ChDying(), TALMaSSObject::m_CurrentStateNo, TAnimal::m_OurLandscape, Partridge_Base::m_state, pars_ChDeveloping, pars_ChDying, pars_ChMaturing, pars_Initiation, and Landscape::Warn().

OnFarmEvent()

bool Partridge_Chick::OnFarmEvent ( FarmToDo  event )

virtual

Farm event handler.

Check and respond to farm events either using config variables for cutting or direct inline values.

Reimplemented from TAnimal.

Reimplemented in Partridge_Chick2.

Definition at line 765 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:
      if ( g_rand_uni() < 0.01 ) ChDying();
    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:
      if ( g_rand_uni() < 0.01 ) ChDying();
    break;
    case fa_ammoniumsulphate:
    break;
    case fa_manure:
    break;
    case fa_greenmanure:
    break;
    case fa_sludge:
    break;
    case herbicide_treat:
    case glyphosate:
    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() < 0.10 ) ChDying();
    break;
    case hilling_up:
    break;
    case water:
      if ( g_rand_uni() < 0.01 ) ChDying();
    break;
    case swathing:
    break;
    case harvest:
      if ( g_rand_uni() < cfg_par_ch_cut.value() ) ChDying();
    break;
    case cattle_out:
    break;
    case cattle_out_low:
    break;
    case cut_to_hay:
      if ( g_rand_uni() < cfg_par_ch_cut.value() ) ChDying();
    break;
    case cut_to_silage:
      if ( g_rand_uni() < cfg_par_ch_cut.value() ) ChDying();
    break;
    case straw_chopping:
    break;
    case hay_turning:
    break;
    case hay_bailing:
      if ( g_rand_uni() < cfg_par_ch_cut.value() ) ChDying();
    break;
    case stubble_harrowing:
    break;
    case autumn_or_spring_plough:
    break;
    case burn_straw_stubble:
    break;
    case mow:
      if ( g_rand_uni() < cfg_par_ch_cut.value() ) ChDying();
    break;
    case cut_weeds:
      if ( g_rand_uni() < cfg_par_ch_cut.value() ) ChDying();
    break;
    case pigs_out:
    break;
    case strigling_sow:
      if ( g_rand_uni() < 10 ) ChDying();
    break;
    default:
      m_OurLandscape->Warn( "Skylark_Clutch::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_ch_cut, ChDying(), 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, 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.

OnYouAreDead()

void Partridge_Chick::OnYouAreDead

(

)

Message handler.

Called by any method that directly kills a chick. Will cause housekeeping to be done by informing those objects that need to know.

Definition at line 1016 of file Partridge_All.cpp.

{
  ChDying();
}

References ChDying().

Referenced by Partridge_Covey::KillExcessChicks(), and Partridge_Communication::PassMessage().

Step()

void Partridge_Chick::Step ( void  )

virtual

Chick Step.

Step only takes care of maturing for this class.

Reimplemented from TAnimal.

Reimplemented in Partridge_Chick2.

Definition at line 709 of file Partridge_All.cpp.

{
  if ( m_CurrentStateNo == -1 || m_StepDone )
    return;
 
  switch ( m_state )
  {
    case pars_Initiation:
      m_state = pars_ChDeveloping;
    case pars_ChDeveloping:
    case pars_ChDying:
      m_StepDone = true;
    break;
    case pars_ChMaturing:
      ChMaturing();
      m_StepDone = true;
    break;
 
    default:
      m_OurLandscape->Warn( "Partridge_Chick::Step - unknown pars type", NULL );
      exit( 1 );
  }
}

References ChMaturing(), TALMaSSObject::m_CurrentStateNo, TAnimal::m_OurLandscape, Partridge_Base::m_state, TALMaSSObject::m_StepDone, pars_ChDeveloping, pars_ChDying, pars_ChMaturing, pars_Initiation, and Landscape::Warn().

Member Data Documentation

m_sex

bool Partridge_Chick::m_sex

protected

Sex.

Definition at line 590 of file Partridge_All.h.

Referenced by ChDying(), ChMaturing(), Partridge_Chick2::ChMaturing(), and Partridge_Chick().

m_starve

int Partridge_Chick::m_starve

protected

Days spent starving.

Definition at line 592 of file Partridge_All.h.

Referenced by ChDeveloping(), and Partridge_Chick().

---

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