ALMaSS Skylark ODDox  1.1
The skylark model description following ODdox protocol
Skylark_Base Class Reference

#include <skylarks_all.h>

Public Member Functions

 Skylark_Base (int x, int y, SkTerritories *Terrs, Landscape *L, Skylark_Population_Manager *SPM, int bx, int by, int mh)
 
virtual void ReInit (int x, int y, SkTerritories *Terrs, Landscape *L, Skylark_Population_Manager *SPM, int bx, int by, int mh)
 
virtual double On_FoodSupply (double)
 
void AddStriglingMort (int lifestage)
 
virtual int WhatState ()
 
bool InSquare (rectangle R)
 
- 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 BeginStep (void)
 BeingStep behaviour - must be implemented in descendent classes. More...
 
virtual void Step (void)
 Step behaviour - must be implemented in descendent classes. More...
 
virtual void EndStep (void)
 EndStep behaviour - must be implemented in descendent classes. More...
 
virtual void ReinitialiseObject (int x, int y, Landscape *L)
 Used to re-use an object - must be implemented in descendent classes. More...
 
virtual void Dying ()
 
void CheckManagement (void)
 
void CheckManagementXY (int x, int y)
 
virtual bool OnFarmEvent (FarmToDo)
 
- Public Member Functions inherited from TALMaSSObject
int GetCurrentStateNo ()
 Returns the current state number. More...
 
void SetCurrentStateNo (int a_num)
 Sets the current state number. More...
 
bool GetStepDone ()
 Returns the step done indicator flag. More...
 
void SetStepDone (bool a_bool)
 Sets the step done indicator flag. More...
 
virtual void ReinitialiseObject ()
 Used to re-use an object - must be implemented in descendent classes. More...
 
 TALMaSSObject ()
 The constructor for TALMaSSObject. More...
 
virtual ~TALMaSSObject ()
 The destructor for TALMaSSObject. More...
 
void OnArrayBoundsError ()
 Used for debugging only, tests basic object properties. More...
 

Public Attributes

double m_pesticide_accumulation
 
double m_pcide_conc
 
TTypesOfSkState m_CurrentSkState
 
int Age
 
double m_Size
 
int m_Born_x
 
int m_Born_y
 
int m_MyHome
 The vegetation type where the skylark was born. More...
 
SkTerritoriesm_OurTerritories
 
Skylark_Population_Managerm_OurPopulationManager
 

Protected Member Functions

bool DailyMortality (int mort)
 
virtual void PesticideResponse ()
 
- Protected Member Functions inherited from TAnimal
void CorrectWrapRound ()
 Corrects wrap around co-ordinate problems. More...
 

Additional Inherited Members

- Protected Attributes inherited from TAnimal
int m_Location_x
 
int m_Location_y
 
Landscapem_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...
 

Constructor & Destructor Documentation

◆ Skylark_Base()

Skylark_Base::Skylark_Base ( int  x,
int  y,
SkTerritories Terrs,
Landscape L,
Skylark_Population_Manager SPM,
int  bx,
int  by,
int  mh 
)
2436  : TAnimal( x, y, L ) {
2437  m_OurTerritories = Terrs;
2438  m_OurPopulationManager = SPM;
2439  // Make sure that the skylark starts in the correct state
2441  m_CurrentStateNo = 0;
2442  m_Born_x = bx;
2443  m_Born_y = by;
2444  m_MyHome = mh;
2446 }

References m_Born_x, m_Born_y, m_CurrentSkState, TALMaSSObject::m_CurrentStateNo, m_MyHome, m_OurPopulationManager, m_OurTerritories, m_pesticide_accumulation, and toss_Initiation.

Member Function Documentation

◆ AddStriglingMort()

void Skylark_Base::AddStriglingMort ( int  lifestage)
inline

◆ DailyMortality()

bool Skylark_Base::DailyMortality ( int  mort)
protected
2464  {
2465 #ifdef __CJTDebug_5
2466  if ( IsAlive() != 0x0DEADC0DE ) DEADCODEError();
2467 #endif
2468  // Timing: Must be called once each day and if true then death
2469  //returns true if the object must die
2470  int ch = random( 10000 );
2471  if ( ch < mort ) return true; else
2472  return false;
2473 }

Referenced by Skylark_Clutch::st_Developing(), Skylark_Nestling::st_Developing(), and Skylark_PreFledgeling::st_Developing().

◆ InSquare()

bool Skylark_Base::InSquare ( rectangle  R)
2479  {
2480 #ifdef __CJTDebug_5
2481  if ( IsAlive() != 0x0DEADC0DE ) DEADCODEError();
2482 #endif
2483  if ( ( m_Location_x >= int( p_R.m_x1 ) ) && ( m_Location_x < int( p_R.m_x2 ) ) && ( m_Location_y >= int( p_R.m_y1 ) )
2484  && ( m_Location_y < int( p_R.m_y2 ) ) )
2485  return true; else
2486  return false;
2487 }

References TAnimal::m_Location_x, TAnimal::m_Location_y, rectangle::m_x1, rectangle::m_x2, rectangle::m_y1, and rectangle::m_y2.

◆ On_FoodSupply()

virtual double Skylark_Base::On_FoodSupply ( double  )
inlinevirtual

Reimplemented in Skylark_Nestling.

607  {
608  return 0.0;
609  }

◆ PesticideResponse()

virtual void Skylark_Base::PesticideResponse ( void  )
inlineprotectedvirtual

Reimplemented in Skylark_Nestling, Skylark_Male, Skylark_Female, and Skylark_PreFledgeling.

629 { return; }

◆ ReInit()

void Skylark_Base::ReInit ( int  x,
int  y,
SkTerritories Terrs,
Landscape L,
Skylark_Population_Manager SPM,
int  bx,
int  by,
int  mh 
)
virtual
2449  {
2450  TAnimal::ReinitialiseObject(x, y, L);
2451  // Assign the pointer to the population manager
2452  m_OurTerritories = Terrs;
2453  m_OurPopulationManager = SPM;
2454  // Make sure that the skylark starts in the correct state
2456  m_CurrentStateNo = 0;
2457  m_Born_x = bx;
2458  m_Born_y = by;
2459  m_MyHome = mh;
2461 }

References m_Born_x, m_Born_y, m_CurrentSkState, TALMaSSObject::m_CurrentStateNo, m_MyHome, m_OurPopulationManager, m_OurTerritories, m_pesticide_accumulation, TALMaSSObject::ReinitialiseObject(), and toss_Initiation.

Referenced by Skylark_Clutch::ReInit(), Skylark_Nestling::ReInit(), and Skylark_Adult::ReInit().

◆ WhatState()

virtual int Skylark_Base::WhatState ( )
inlinevirtual

Reimplemented from TAnimal.

619  {
620  return m_CurrentSkState;
621  }

Referenced by Skylark_Population_Manager::ProbePOM().

Member Data Documentation

◆ Age

◆ m_Born_x

◆ m_Born_y

◆ m_CurrentSkState

TTypesOfSkState Skylark_Base::m_CurrentSkState

Referenced by Skylark_Female::BeginStep(), Skylark_Male::BeginStep(), Skylark_Population_Manager::BreedingPairsOutput(), Skylark_Clutch::EndStep(), Skylark_Nestling::EndStep(), Skylark_PreFledgeling::EndStep(), Skylark_Male::EndStep(), Skylark_Female::OnBroodDeath(), Skylark_Male::OnBroodDeath(), Skylark_Female::OnClutchDeath(), Skylark_Nestling::OnDeserted(), Skylark_Male::OnEggHatch(), Skylark_Female::OnEggsHatch(), Skylark_Male::OnEvicted(), Skylark_Clutch::OnFarmEvent(), Skylark_Nestling::OnFarmEvent(), Skylark_PreFledgeling::OnFarmEvent(), Skylark_Female::OnFarmEvent(), Skylark_Male::OnFarmEvent(), Skylark_Female::OnMateDying(), Skylark_Male::OnMateDying(), Skylark_Female::OnMateHomeless(), Skylark_Male::OnMateLeaving(), Skylark_Clutch::OnMumGone(), Skylark_Male::OnPairing(), Skylark_Male::OnPreFledgelingMature(), Skylark_Male::OnReHouse(), Skylark_Female::OnStopFeedingChicks(), Skylark_Nestling::OnYouHaveBeenEaten(), Skylark_Nestling::PesticideResponse(), Skylark_PreFledgeling::PesticideResponse(), ReInit(), Skylark_PreFledgeling::ReInit(), Skylark_Female::SensibleCopy(), Skylark_Male::SensibleCopy(), Skylark_Base(), Skylark_PreFledgeling::Skylark_PreFledgeling(), Skylark_Clutch::st_Dying(), Skylark_Nestling::st_Dying(), Skylark_PreFledgeling::st_Dying(), Skylark_Female::st_Dying(), Skylark_Male::st_Dying(), Skylark_Male::st_FollowingMate(), Skylark_Clutch::Step(), Skylark_Nestling::Step(), Skylark_PreFledgeling::Step(), Skylark_Female::Step(), and Skylark_Male::Step().

◆ m_MyHome

◆ m_OurPopulationManager

◆ m_OurTerritories

◆ m_pcide_conc

double Skylark_Base::m_pcide_conc

◆ m_pesticide_accumulation

◆ m_Size


The documentation for this class was generated from the following files:
Skylark_Population_Manager::AddStriglingMort
void AddStriglingMort(int lifestage)
Definition: skylarks_all.h:552
Skylark_Base::m_CurrentSkState
TTypesOfSkState m_CurrentSkState
Definition: skylarks_all.h:594
Skylark_Base::m_Born_y
int m_Born_y
Definition: skylarks_all.h:598
Skylark_Base::m_OurTerritories
SkTerritories * m_OurTerritories
Definition: skylarks_all.h:602
TAnimal::TAnimal
TAnimal(int x, int y, Landscape *L)
Skylark_Base::m_MyHome
int m_MyHome
The vegetation type where the skylark was born.
Definition: skylarks_all.h:600
TAnimal::m_Location_y
int m_Location_y
Definition: PopulationManager.h:228
toss_Initiation
Definition: skylarks_all.h:45
Skylark_Base::m_Born_x
int m_Born_x
Definition: skylarks_all.h:597
Skylark_Base::m_pesticide_accumulation
double m_pesticide_accumulation
Definition: skylarks_all.h:592
Skylark_Base::m_OurPopulationManager
Skylark_Population_Manager * m_OurPopulationManager
Definition: skylarks_all.h:603
TALMaSSObject::ReinitialiseObject
virtual void ReinitialiseObject()
Used to re-use an object - must be implemented in descendent classes.
Definition: PopulationManager.h:143
TALMaSSObject::m_CurrentStateNo
int m_CurrentStateNo
The basic state number for all objects - '-1' indicates death.
Definition: PopulationManager.h:116
TAnimal::m_Location_x
int m_Location_x
Definition: PopulationManager.h:225