Skylark_Adult Class Reference

#include <skylarks_all.h>

Inheritance diagram for Skylark_Adult:

Public Member Functions
	Skylark_Adult (int x, int y, double size, int age, SkTerritories *Terrs, Landscape *L, Skylark_Population_Manager *SPM, int bx, int by, int mh)
virtual void	ReInit (int x, int y, double size, int age, SkTerritories *Terrs, Landscape *L, Skylark_Population_Manager *SPM, int bx, int by, int mh)
	~Skylark_Adult () override
virtual void	CopyMyself (int a_sktype)
Public Member Functions inherited from Skylark_Base
	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 (const int lifestage) const
int	WhatState () override
	Returns the objects current state number. More...
bool	InSquare (rectangle R) const
Public Member Functions inherited from TAnimal
	TAnimal (int x, int y, Landscape *L)
	The TAnimal constructor saving the x,y, location and the landscape pointer. More...
	TAnimal (int x, int y)
	The TAnimal constructor saving the x,y used if landscape is already set. More...
void	SetGuardMapIndex (int a_index_x, int a_index_y)
	Set the guard map index, this is used to avoid two animals operating in the same location when using multithread. More...
unsigned	SupplyFarmOwnerRef () const
	Get the current location farm ref if any. More...
AnimalPosition	SupplyPosition () const
	Returns the objects location and habitat type and veg type. More...
APoint	SupplyPoint () const
	Returns the objects location in ALMaSS coordinates. More...
int	SupplyPolygonRef () const
	Returns the polygon reference where the object is located. More...
TTypesOfLandscapeElement	SupplyPolygonType () const
	Returns the polygon type where the object is located. More...
int	Supply_m_Location_x () const
	Returns the ALMaSS x-coordinate. More...
int	Supply_m_Location_y () const
	Returns the ALMaSS y-coordinate. More...
int	SupplyGuardCellX () const
	Returns the x-index to the guard cell. More...
int	SupplyGuardCellY () const
	Returns the y-index to the guard cell. More...
int	SupplyAge () const
	Returns the animals age in days. More...
void	SetAge (int a_age)
	Sets the animals age in days. More...
virtual void	KillThis ()
	Sets all parameters ready for object destruction. More...
virtual void	CopyMyself ()
	Used to copy the object details to another in descendent classes. More...
void	SetX (const int a_x)
	Sets the x-coordinate. More...
void	SetY (const int a_y)
	Sets the y-coordinate. More...
virtual void	ReinitialiseObject (int a_x, int a_y, Landscape *a_l_ptr)
virtual void	ReinitialiseObject (int a_x, int a_y)
	Used to re-use an object - must be implemented in descendent classes. More...
virtual void	Dying ()
	A wrapped for KillThis - ideally should not be used. More...
void	CheckManagement ()
	Used to start a check for any management related effects at the objects current location. More...
void	CheckManagementXY (int a_x, int a_y)
	Used to start a check for any management related effects at x,y. More...
virtual bool	OnFarmEvent (FarmToDo)
	Must be reimplemented if used in descendent classes. Sets the action on a management event. More...
Public Member Functions inherited from TALMaSSObject
int	GetCurrentStateNo () const
	Returns the current state number. More...
void	SetCurrentStateNo (int a_num)
	Sets the current state number. More...
bool	GetStepDone () const
	Returns the step done indicator flag. More...
void	SetStepDone (bool a_bool)
	Sets the step done indicator flag. More...
virtual void	BeginStep ()
	BeingStep behaviour - must be implemented in descendent classes. More...
virtual void	Step ()
	Step behaviour - must be implemented in descendent classes. More...
virtual void	EndStep ()
	EndStep behaviour - must be implemented in descendent classes. More...
void	ReinitialiseObjectBase ()
	Used to initialise an object. More...
	TALMaSSObject ()
	The constructor for TALMaSSObject. More...
virtual	~TALMaSSObject ()=default
	The destructor for TALMaSSObject. More...

Public Attributes
bool	Paired
Public Attributes inherited from Skylark_Base
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...
SkTerritories *	m_OurTerritories
Skylark_Population_Manager *	m_OurPopulationManager

Protected Member Functions
virtual double	RemoveEM (double food)
double	GetVegHindrance (int PolyRef) const
double	GetWeatherHindrance () const
Protected Member Functions inherited from TAnimal
void	CorrectWrapRound ()
	Corrects wrap around co-ordinate problems. More...

Static Protected Member Functions
static bool	GetBadWeather ()
	Extreme weather conditions check. More...
Static Protected Member Functions inherited from Skylark_Base
static bool	DailyMortality (int mort)

Protected Attributes
int	GoodWeather
bool	BSuccess
double	MyExtractEff
int	m_pesticide_affected
skTerritory_struct	MyTerritory
vector< APoint > *	m_aTerrlist
Protected Attributes inherited from TAnimal
int	m_Location_x
	The objects ALMaSS x coordinate. More...
int	m_Location_y
	The objects ALMaSS y coordinate. More...
int	m_guard_cell_x
	The index x to the guard cell. More...
int	m_guard_cell_y
	The index y to the guard cell. More...
int	m_AgeDays {0}
	To hold the age in days. More...
PesticideToxicity	m_my_pesticide
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
Static Public Member Functions inherited from TAnimal
static void	SetSimulationWidth (int a_value)
	Sets the simulation width. More...
static void	SetSimulationHeight (int a_value)
	Sets the simulation height. More...
static void	SetDayInYear (int a_value)
	Sets the day in year attribute. More...
static void	SetOurLandscape (Landscape *a_value)
	Sets the landscape pointer. More...
static void	SetTempToday (double a_value)
	Sets the temperature today attribute. More...
Static Public Member Functions inherited from TALMaSSObject
static void	OnArrayBoundsError ()
	Used for debugging only, tests basic object properties. More...
Static Protected Attributes inherited from TAnimal
static Landscape *	m_OurLandscape = nullptr
	A pointer to the landscape object shared with all TAnimal objects. More...
static int	m_SimulationWidth = 0
	A static member for the simulation width because it is often used by descendent classes. More...
static int	m_SimulationHeight = 0
	A static member for the simulation height because it is often used by descendent classes. More...
static double	m_TemperatureToday = 0.0
	A holder for the temperature today shared with all TAnimal objects. More...
static int	m_DayInYear = 0
	A holder for the day in year shared with all TAnimal objects. More...

Constructor & Destructor Documentation

Skylark_Adult()

Skylark_Adult::Skylark_Adult	(	int	x,
		int	y,
		double	size,
		int	age,
		SkTerritories *	Terrs,
		Landscape *	L,
		Skylark_Population_Manager *	SPM,
		int	bx,
		int	by,
		int	mh
	)

                                                                                                        : Skylark_Base(
    x, y, Terrs, L, SPM, bx, by, mh) {
    m_Size = size;
    Age = age;
    BSuccess = false;
    MyExtractEff = (0.90 + g_random_fnc(21) / 100.0) * MeanExtractionRatePerMinute;
    GoodWeather = 0;
    Paired = false;
    MyTerritory.ref = -1;
    m_aTerrlist = new vector<APoint>;
    m_pesticide_affected = -1;
}

References Skylark_Base::Age, BSuccess, g_random_fnc(), GoodWeather, m_aTerrlist, m_pesticide_affected, Skylark_Base::m_Size, MeanExtractionRatePerMinute, MyExtractEff, MyTerritory, Paired, and skTerritory_struct::ref.

~Skylark_Adult()

Skylark_Adult::~Skylark_Adult ( )

override

{ delete m_aTerrlist; }

References m_aTerrlist.

Member Function Documentation

CopyMyself()

void Skylark_Adult::CopyMyself ( int  a_sktype )

virtual

                                                 {
    const auto aps = new AdultSkylark_struct;
    aps->x = m_Location_x;
    aps->y = m_Location_y;
    aps->size = m_Size;
    aps->Terrs = m_OurTerritories;
    aps->L = m_OurLandscape;
    aps->sex = false;
    aps->age = 0;
    aps->bx = m_Born_x;
    aps->mh = m_MyHome;
    aps->by = m_Born_y;
    m_OurPopulationManager->CreateObjects(a_sktype, this, nullptr, aps, -1);
    // object will be destroyed by death state
    // but must let Dad know anyway
    delete aps;
}

References Skylark_Population_Manager::CreateObjects(), Skylark_Base::m_Born_x, Skylark_Base::m_Born_y, TAnimal::m_Location_x, TAnimal::m_Location_y, Skylark_Base::m_MyHome, TAnimal::m_OurLandscape, Skylark_Base::m_OurPopulationManager, Skylark_Base::m_OurTerritories, Skylark_Base::m_Size, and Skylark_struct::x.

Referenced by Skylark_Population_Manager::Catastrophe().

GetBadWeather()

bool Skylark_Adult::GetBadWeather ( )

staticprotected

Extreme weather conditions check.

                                  {
    //return m_OurPopulationManager->IsBadWeather();
    return false;
}

Referenced by Skylark_Female::st_Arriving(), Skylark_Male::st_Arriving(), Skylark_Female::st_BuildingUpResources(), Skylark_Female::st_Finding_Territory(), Skylark_Female::st_Floating(), Skylark_Male::st_Floating(), Skylark_Female::st_Flocking(), Skylark_Male::st_Flocking(), Skylark_Female::st_TempLeavingArea(), and Skylark_Male::st_TempLeavingArea().

GetVegHindrance()

double Skylark_Adult::GetVegHindrance ( int  PolyRef ) const

protected

                                                             {
#ifdef __CJTDebug_5
  if ( IsAlive() != 0x0DEADC0DE ) DEADCODEError();
#endif
    /* CJT Changed in favour of a function of veg density double veg_biomass = m_OurLandscape->SupplyVegBiomass(polyref);
    double veg_height = m_OurLandscape->SupplyVegHeight(polyref); int bio = (int)floor(0.5+veg_biomass/(VeryHighDensityVeg/
    double(HindranceBiomassCategories))); // 0-24, 25-49, 50-74,74-100 categories
    int hei=(int)floor(0.5+veg_height/(100.0/double(HindranceHeightCategories)));
    if (hei>HindranceHeightCategories-1) hei=HindranceHeightCategories-1;
    if (bio>HindranceBiomassCategories-1) bio=HindranceBiomassCategories-1; return VegHindrance[hei][bio]; */
    if (m_OurLandscape->SupplyVegPatchy(polyref)) return 1.0;
    const int veg_height = static_cast<int>(floor(0.5 + m_OurLandscape->SupplyVegHeight(polyref)));
    if (veg_height < 26) return 1.0;
    const int veg_dens = m_OurLandscape->SupplyVegDensity(polyref);
    //    double vh = ( VegHindranceH[ veg_height ] * 2 + VegHindranceD[ veg_dens ] ) / 3.0;
    //double vh = (0.33*( DensityScore[ veg_dens ] + 2 * HeightScore[ ( int )veg_height ] ) * 0.33333333)+0.67;
    double vh = (VegHindranceD[veg_dens] + 2 * VegHindranceH[veg_height]) * 0.3333;
    //cout<<veg_dens<<" "<<veg_height<<" "<<vh<<endl;
#ifdef __TRAMLINES_ON
    // Tramlines affect the amount of veg hindrance only
    // vh must be increased by a factor corresponding to the tramline effect
    // IF USING SKLARK SCRAPES !
    if (m_OurLandscape->SupplySkScrapes(polyref)) { vh += (1.0 - vh) * cfg_tramline_foraging.value(); }
    else if (m_OurLandscape->SupplyHasTramlines(polyref)) { vh += (1.0 - vh) * cfg_tramline_foraging.value(); }
#endif
    return vh;
}

References cfg_tramline_foraging, TAnimal::m_OurLandscape, Landscape::SupplyHasTramlines(), Landscape::SupplySkScrapes(), Landscape::SupplyVegDensity(), Landscape::SupplyVegHeight(), Landscape::SupplyVegPatchy(), CfgFloat::value(), VegHindranceD, and VegHindranceH.

Referenced by Skylark_Male::GetFood().

GetWeatherHindrance()

double Skylark_Adult::GetWeatherHindrance ( ) const

protected

                                                {
#ifdef __CJTDebug_5
  if ( IsAlive() != 0x0DEADC0DE ) DEADCODEError();
#endif
    int rain = static_cast<int>(m_OurLandscape->SupplyRain()) / 2;
    // Assume half of this falls at night
    // Make sure the indices remain in bounds
    if (rain > 10) rain = 10;
    int temp = static_cast<int>(floor(0.5 + m_OurLandscape->SupplyTemp()));
    if (temp < 0) temp = 0;
    if (temp > 20) temp = 20;
    double hind = RainHindrance[rain];
    hind *= TempHindrance[temp];
    return hind;
}

References TAnimal::m_OurLandscape, RainHindrance, Landscape::SupplyRain(), Landscape::SupplyTemp(), and TempHindrance.

Referenced by Skylark_Male::GetFood().

ReInit()

void Skylark_Adult::ReInit ( int  x, int  y, double  size, int  age, SkTerritories *  Terrs, Landscape *  L, Skylark_Population_Manager *  SPM, int  bx, int  by, int  mh  )

virtual

Reimplemented in Skylark_Male, and Skylark_Female.

                                                                                                      {
    Skylark_Base::ReInit(x, y, Terrs, L, SPM, bx, by, mh);
    m_Size = size;
    Age = age;
    BSuccess = false;
    MyExtractEff = (0.90 + g_random_fnc(21) / 100.0) * MeanExtractionRatePerMinute;
    GoodWeather = 0;
    Paired = false;
    MyTerritory.ref = -1;
    m_aTerrlist = new vector<APoint>;
    m_pesticide_affected = -1;
}

References Skylark_Base::Age, BSuccess, g_random_fnc(), GoodWeather, m_aTerrlist, m_pesticide_affected, Skylark_Base::m_Size, MeanExtractionRatePerMinute, MyExtractEff, MyTerritory, Paired, skTerritory_struct::ref, and Skylark_Base::ReInit().

Referenced by Skylark_Female::ReInit(), and Skylark_Male::ReInit().

RemoveEM()

double Skylark_Adult::RemoveEM ( double  food )

protectedvirtual

                                          {
#ifdef __CJTDebug_5
  if ( IsAlive() != 0x0DEADC0DE ) DEADCODEError();
#endif
    // remove metabolic requirements
    const double used = m_OurPopulationManager->SupplyEMi();
#ifdef __PESTICIDE_RA_ADULT
    // If using pesticide risk assessment then the total mg of pesticide collected that day are now in m_pcide
    // But, there well be more than we wanted, so now we take a mean as mg/kcal resource
    m_pcide_conc = m_pcide / food;
    // Note there is an assumption here that they only eat insects. We know this to be incorrect so depending upon the
    // aim of the assessment the line below may need to be modified (e.g. by scaling by the relative calorific content of
    // insects compared to plant matter.
    m_pesticide_accumulation = m_pesticide_accumulation + m_pcide_conc * used;
#endif
    food -= used;
    if (food < 0) food = 0;
    return food; // Food still in gdw insects
}

References Skylark_Base::m_OurPopulationManager, and Skylark_Population_Manager::SupplyEMi().

Referenced by Skylark_Female::FeedYoung(), Skylark_Male::st_CaringForYoung(), and Skylark_Female::st_PreparingForBreeding().

Member Data Documentation

BSuccess

bool Skylark_Adult::BSuccess

protected

Referenced by Skylark_Male::DefendTerritory(), Skylark_Female::EstablishTerritory(), Skylark_Female::OnBreedingSuccess(), Skylark_Female::OnMaleNeverComesBack(), Skylark_Male::OnMateDying(), Skylark_Female::OnMateHomeless(), Skylark_Male::OnMateLeaving(), Skylark_Male::OnMateNeverComesBack(), Skylark_Male::OnPairing(), Skylark_Male::OnPreFledgelingMature(), ReInit(), Skylark_Male::ReInit(), Skylark_Adult(), Skylark_Male::Skylark_Male(), Skylark_Female::st_Finding_Territory(), Skylark_Female::st_GivingUpTerritory(), Skylark_Male::st_Immigrating(), Skylark_Male::st_ScaringOffChicks(), and Skylark_Female::st_StoppingBreeding().

GoodWeather

int Skylark_Adult::GoodWeather

protected

Referenced by ReInit(), Skylark_Adult(), Skylark_Female::st_Emigrating(), Skylark_Female::st_Flocking(), and Skylark_Female::st_TempLeavingArea().

m_aTerrlist

vector<APoint>* Skylark_Adult::m_aTerrlist

protected

Referenced by Skylark_Male::EstablishingATerritory(), Skylark_Male::OnEvicted(), ReInit(), Skylark_Adult(), Skylark_Male::st_Arriving(), Skylark_Male::st_FindingTerritory(), and ~Skylark_Adult().

m_pesticide_affected

int Skylark_Adult::m_pesticide_affected

protected

Referenced by ReInit(), Skylark_Adult(), Skylark_Female::st_Emigrating(), Skylark_Female::st_Immigrating(), Skylark_Female::st_Laying(), and Skylark_Female::st_MakingNest().

MyExtractEff

double Skylark_Adult::MyExtractEff

protected

Referenced by Skylark_Female::GetFood(), Skylark_Male::GetFood(), ReInit(), and Skylark_Adult().

MyTerritory

skTerritory_struct Skylark_Adult::MyTerritory

protected

Referenced by Skylark_Female::CheckForFields(), Skylark_Male::ConstructAHabitatTable(), Skylark_Male::EstablishingATerritory(), Skylark_Female::EstablishTerritory(), Skylark_Male::OnEvicted(), Skylark_Female::OnMateDying(), Skylark_Female::OnMateHomeless(), Skylark_Male::OnMateLeaving(), Skylark_Male::OnReHouse(), Skylark_Male::ReEvaluateTerritory(), ReInit(), Skylark_Adult(), Skylark_Male::st_Arriving(), Skylark_Male::st_AttractingAMate(), Skylark_Female::st_Dying(), Skylark_Male::st_Dying(), Skylark_Male::st_FindingTerritory(), Skylark_Male::st_FollowingMate(), Skylark_Female::st_GivingUpTerritory(), Skylark_Female::st_StoppingBreeding(), and Skylark_Male::Supply_Territory().

Paired

bool Skylark_Adult::Paired

Referenced by Skylark_Male::DefendTerritory(), Skylark_Female::EstablishTerritory(), Skylark_Female::OnBroodDeath(), Skylark_Male::OnBroodDeath(), Skylark_Female::OnClutchDeath(), Skylark_Male::OnEvicted(), Skylark_Female::OnFarmEvent(), Skylark_Female::OnMaleNeverComesBack(), Skylark_Male::OnMateDying(), Skylark_Female::OnMateHomeless(), Skylark_Male::OnMateLeaving(), Skylark_Male::OnMateNeverComesBack(), Skylark_Male::OnPairing(), Skylark_Male::OnPreFledgelingMature(), Skylark_Male::OnReHouse(), ReInit(), Skylark_Adult(), Skylark_Female::st_Arriving(), Skylark_Male::st_Dying(), Skylark_Female::st_Finding_Territory(), Skylark_Male::st_FollowingMate(), Skylark_Female::st_GivingUpTerritory(), Skylark_Clutch::st_Hatching(), Skylark_Female::st_Immigrating(), Skylark_Male::st_Immigrating(), Skylark_Female::st_StoppingBreeding(), Skylark_Female::Step(), and Skylark_Population_Manager::TheRipleysOutputProbe().

---

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

• /builds/ALMaSS/ALMaSS_MIDox/Skylark/skylarks_all.h
• /builds/ALMaSS/ALMaSS_MIDox/Skylark/skylarks_all.cpp