Spider_Egg Class Reference

The generic base class for spider eggsacs
More...

#include <Spider_BaseClasses.h>

Inheritance diagram for Spider_Egg:

Public Member Functions
void	EndStep ()
	EndStep behaviour - must be implemented in descendent classes. More...
	Spider_Egg (int x, int y, Landscape *L, Spider_Population_Manager *EPM, int Eggs)
	The Spider_Egg constructor More...
virtual void	ReInit (int x, int y, Landscape *L, Spider_Population_Manager *EPM, int Eggs)
	Used to reinitialise and object More...
virtual void	BeginStep ()
	The begin step code More...
virtual void	Step ()
	The Step code More...
void	SetNoEggs (int Eggs)
	Sets the number of eggs attribute More...
int	GetNoEggs ()
	Returns the number of eggs in the eggsac More...
virtual bool	OnFarmEvent (FarmToDo event)
	Determines the impact of any farm management events at the eggsac's location More...
Public Member Functions inherited from Spider_Base
	Spider_Base (int x, int y, Landscape *L, Spider_Population_Manager *SpMan)
	Constructor More...
void	ReInit (int x, int y, Landscape *L, Spider_Population_Manager *SpMan)
	Reinitialise object code More...
void	Init (Spider_Population_Manager *p_spMan)
	Used it initialise objects (also used by ReInit) More...
virtual int	WhatState ()
	Returns the current spider behavioural state More...
virtual void	KillThis ()
	Destroys the spider More...
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	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...
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...
void	ReinitialiseObjectBase ()
	Used to initialise an object. More...
	TALMaSSObject ()
	The constructor for TALMaSSObject. More...
virtual	~TALMaSSObject ()=default
	The destructor for TALMaSSObject. More...

Static Public Attributes
static int	m_HatDensityDepMortConst = 0
	This is a space for holding cfg species specific parameters - this is the mortality constant associated with Spider_Egg::Hatch. More...
static int	m_DailyEggMortConst = 0
	This is a space for holding cfg species specific parameters - this is the daily egg mortality probability Spider_Egg::st_Develop. More...
static double	m_EggDevelConst = 0
	This is a space for holding cfg species specific parameters - this is a developmental threshold for hatch in Spider_Egg::st_Develop. More...
Static Public Attributes inherited from Spider_Base
static int	m_DenDependenceConst0 = 0
	This is the number of local spiders needed before density dependent mortality will kill More...
static int	m_SimW = 0
	The width of the landscape More...
static int	m_SimH = 0
	The height of the landscape More...

Protected Member Functions
TTypesOfSpiderState	st_Develop ()
	The behavioural state develop More...
virtual void	st_Hatch ()
	The behavioural state hatch More...
virtual void	st_Die ()
	The behavioural state die More...
virtual void	Hatch (int a_eggsackspread, unsigned a_doubleeggsacspread, unsigned a_noeggs, unsigned a_range)
	Determines the number and location of spiderlings to survive hatching and triggers creation of juvenile objects More...
Protected Member Functions inherited from Spider_Base
virtual bool	EggPosValid (unsigned a_x, unsigned a_y)
	Checks if its possible to create an eggsac here More...
bool	HatchDensityMort (int a_x, int a_y, int a_range)
	Checks for density-dependent mortality at this location More...
virtual int	CheckPosMap (unsigned x, unsigned y)
	Returns the value in m_OurPosMap for this location More...
virtual bool	GetPosMapPositive (unsigned x, unsigned y, unsigned range)
	Returns whether there are any non-zero values within range of this coordinate (TL corner) More...
virtual int	GetPosMapDensity (unsigned x, unsigned y, unsigned range)
	Returns total number of non-zero locations within range of this coordinate (TL corner) More...
virtual void	ClearPosMap (unsigned x, unsigned y)
	Clears a PosMap location More...
virtual void	SetPosMap (unsigned x, unsigned y)
	Sets a PosMap location to non-zero More...
Protected Member Functions inherited from TAnimal
void	CorrectWrapRound ()
	Corrects wrap around co-ordinate problems. More...

Protected Attributes
int	m_DateLaid
	The day in year the eggsac was produced More...
int	m_NoEggs
	The number of eggs contained in the eggsac More...
Protected Attributes inherited from Spider_Base
double	m_AgeDegrees
	A local pointer the population manager More...
int	m_Age
	Stores the spiders age in days More...
TTypesOfSpiderState	m_CurrentSpState
	Stores the current behavioural state More...
unsigned	m_Lifestage { 0 }
	This is a useful parameter holding the spider type. More...
SimplePositionMap *	m_OurPosMap
	Contains a pointer to the relevant position map - allocation of this must be controlled by the descendent class init. More...
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...
Public Attributes inherited from Spider_Base
double	m_pesticide_accum
	Body-burden of pesticde More...
Spider_Population_Manager *	m_OurPopulationManager
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...

Detailed Description

The generic base class for spider eggsacs

Constructor & Destructor Documentation

Spider_Egg()

Spider_Egg::Spider_Egg	(	int	x,
		int	y,
		Landscape *	L,
		Spider_Population_Manager *	EPM,
		int	Eggs
	)

The Spider_Egg constructor

                                                                                            :  Spider_Base(x, y, L, SpPM) {
    m_DateLaid = L->SupplyDayInYear();
    m_NoEggs = Eggs;
    m_OurPosMap = SpPM->m_EggPosMap;
}

References m_DateLaid, Spider_Population_Manager::m_EggPosMap, m_NoEggs, Spider_Base::m_OurPosMap, and Landscape::SupplyDayInYear().

Member Function Documentation

BeginStep()

void Spider_Egg::BeginStep ( void  )

virtual

The begin step code

Reimplemented from TALMaSSObject.

                           {
    CheckManagement();
}

References TAnimal::CheckManagement().

EndStep()

void Spider_Egg::EndStep ( void  )

virtual

EndStep behaviour - must be implemented in descendent classes.

Reimplemented from TALMaSSObject.

                         {
    // Arbitrary pesticide influence code.
#ifdef __SPIDER_PESTICIDE
    m_pesticide_accum *= cfg_SpiderEggPPPElimiationRate.value();
    // Pick up the pesticide to add to the body burden
    m_pesticide_accum += m_OurLandscape->SupplyPesticide(m_Location_x, m_Location_y, ppp_1);
    if (m_pesticide_accum > cfg_SpiderEggPPPThreshold.value())
    {
        // Kill the spider following a fixed probability of death. The test is taken each day until it dies.
        if (g_rand_uni_fnc() < cfg_SpiderEggPPPEffectProb.value()) { m_CurrentSpState = tosps_Dying; }
    }
#endif
}

References cfg_SpiderEggPPPEffectProb, cfg_SpiderEggPPPElimiationRate, cfg_SpiderEggPPPThreshold, g_rand_uni_fnc(), Spider_Base::m_CurrentSpState, TAnimal::m_Location_x, TAnimal::m_Location_y, TAnimal::m_OurLandscape, Spider_Base::m_pesticide_accum, ppp_1, Landscape::SupplyPesticide(), tosps_Dying, and CfgFloat::value().

GetNoEggs()

int Spider_Egg::GetNoEggs ( )

inline

Returns the number of eggs in the eggsac

{ return m_NoEggs; }

References m_NoEggs.

Hatch()

void Spider_Egg::Hatch ( int  a_eggsackspread, unsigned  a_doubleeggsacspread, unsigned  a_noeggs, unsigned  a_range  )

protectedvirtual

Determines the number and location of spiderlings to survive hatching and triggers creation of juvenile objects

{
    // Intially spreads the spiders over a EggSacSpread x EggSacSpread area
    // so as to minimise local density dependence
 
    unsigned Eggs = 0;
    struct_Spider* SS;
    SS = new struct_Spider;
    SS->L = m_OurLandscape;
    SS->SpPM = m_OurPopulationManager;
    // do this to avoid testing from wrap around
    // - always moves co-ords away from edge
    int mx = m_Location_x;
    int my = m_Location_y;
    if (mx < a_eggsackspread) mx = a_eggsackspread;
    if (my < a_eggsackspread) my = a_eggsackspread;
    if (mx + a_eggsackspread >= m_SimW)  mx = m_SimW - (a_eggsackspread + 1);
    if (my + a_eggsackspread >= m_SimH)  my = m_SimH - (a_eggsackspread + 1);
    int tx, ty;
    int tries = 0;
    while ((Eggs < a_noeggs) & (tries < 500)) {
        tries++;
        tx = mx + g_random_fnc(a_doubleeggsacspread) - a_eggsackspread;
        ty = my + g_random_fnc(a_doubleeggsacspread) - a_eggsackspread;
        if (EggPosValid(tx, ty))
        {
            // Must write to the position map
            if (m_OurPopulationManager->m_JuvPosMap->GetMapValue(tx, ty) == 0) {
                if (!HatchDensityMort(tx, ty, a_range)) {
                    m_OurPopulationManager->m_JuvPosMap->SetMapValue(tx, ty); // This one needs specifically to access a position map that is not m_OurPosMap
                    SS->x = tx;
                    SS->y = ty;
                    m_OurPopulationManager->CreateObjects(tspi_Spiderling, this, SS, 1);
                }
                Eggs++;
            }
        }
 
    }
    delete SS;
}

References Spider_Population_Manager::CreateObjects(), Spider_Base::EggPosValid(), g_random_fnc(), SimplePositionMap::GetMapValue(), Spider_Base::HatchDensityMort(), struct_Spider::L, Spider_Population_Manager::m_JuvPosMap, TAnimal::m_Location_x, TAnimal::m_Location_y, TAnimal::m_OurLandscape, Spider_Base::m_OurPopulationManager, Spider_Base::m_SimH, Spider_Base::m_SimW, SimplePositionMap::SetMapValue(), struct_Spider::SpPM, tspi_Spiderling, struct_Spider::x, and struct_Spider::y.

Referenced by st_Hatch().

OnFarmEvent()

virtual bool Spider_Egg::OnFarmEvent ( FarmToDo  event )

inlinevirtual

Determines the impact of any farm management events at the eggsac's location

Reimplemented from Spider_Base.

Reimplemented in Oedothorax_Egg, and Erigone_Egg.

{ return true; }

ReInit()

void Spider_Egg::ReInit ( int  x, int  y, Landscape *  L, Spider_Population_Manager *  EPM, int  Eggs  )

virtual

Used to reinitialise and object

                                                                                             {
    Spider_Base::ReInit(x, y, L, SpPM);
    m_DateLaid = L->SupplyDayInYear();
    m_NoEggs = Eggs;
    m_OurPopulationManager = SpPM;
    m_OurPosMap = SpPM->m_EggPosMap;
}

References m_DateLaid, Spider_Population_Manager::m_EggPosMap, m_NoEggs, Spider_Base::m_OurPopulationManager, Spider_Base::m_OurPosMap, Spider_Base::ReInit(), and Landscape::SupplyDayInYear().

SetNoEggs()

void Spider_Egg::SetNoEggs ( int  Eggs )

inline

Sets the number of eggs attribute

{ m_NoEggs = Eggs; }

References m_NoEggs.

st_Develop()

TTypesOfSpiderState Spider_Egg::st_Develop ( void  )

protected

The behavioural state develop

                                           {
    //if (random(10000) < cfg_Erig_DailyEggMort.value()) return tosps_Dying; // stochastic mortality go to die
    if (g_random_fnc(10000) < m_DailyEggMortConst) return tosps_Dying; // stochastic mortality go to die
    if (m_OurPopulationManager->GetEggDevelDegrees(m_DateLaid) > m_EggDevelConst) {
        //m_OurPopulation->WriteToTestFile(2, m_OurLandscape->SupplyDayInYear());
        return tosps_Hatch; // go to hatch
    }
    else
    {
        m_StepDone = true;
        return tosps_Develop; // carry on developing
    }
}

References g_random_fnc(), Spider_Population_Manager::GetEggDevelDegrees(), m_DailyEggMortConst, m_DateLaid, m_EggDevelConst, Spider_Base::m_OurPopulationManager, TALMaSSObject::m_StepDone, tosps_Develop, tosps_Dying, and tosps_Hatch.

Referenced by Step().

st_Die()

void Spider_Egg::st_Die ( )

protectedvirtual

The behavioural state die

                        {
    m_OurPopulationManager->m_EggPosMap->ClearMapValue(m_Location_x, m_Location_y);
    m_CurrentStateNo = -1;
}

References SimplePositionMap::ClearMapValue(), TALMaSSObject::m_CurrentStateNo, Spider_Population_Manager::m_EggPosMap, TAnimal::m_Location_x, TAnimal::m_Location_y, and Spider_Base::m_OurPopulationManager.

Referenced by Step().

st_Hatch()

void Spider_Egg::st_Hatch ( void  )

protectedvirtual

The behavioural state hatch

                          {
    Hatch(m_OurPopulationManager->GetEggSacSpread(), m_OurPopulationManager->GetDoubleEggSacSpread(), m_NoEggs, m_HatDensityDepMortConst);
    m_OurPopulationManager->m_EggPosMap->ClearMapValue(m_Location_x, m_Location_y);
    m_CurrentSpState = tosps_Destroy; //Destroys object
    m_CurrentStateNo = -1;
}

References SimplePositionMap::ClearMapValue(), Spider_Population_Manager::GetDoubleEggSacSpread(), Spider_Population_Manager::GetEggSacSpread(), Hatch(), Spider_Base::m_CurrentSpState, TALMaSSObject::m_CurrentStateNo, Spider_Population_Manager::m_EggPosMap, m_HatDensityDepMortConst, TAnimal::m_Location_x, TAnimal::m_Location_y, m_NoEggs, Spider_Base::m_OurPopulationManager, and tosps_Destroy.

Referenced by Step().

Step()

void Spider_Egg::Step ( void  )

virtual

The Step code

Reimplemented from TALMaSSObject.

                      {
    if (m_StepDone || m_CurrentStateNo == -1) return;
#ifdef __CJTDebug_5
    if (IsAlive() != 0x0DEADC0DE) DEADCODEError();
#endif
    switch (m_CurrentSpState) {
    case tosps_Initiation: // Initial
        m_CurrentSpState = tosps_Develop;
        break;
    case tosps_Develop:
        m_CurrentSpState = st_Develop();
        break;
    case tosps_Hatch:
        st_Hatch();
        m_StepDone = true;
        break;
 
    case tosps_Dying:
        st_Die();
        m_StepDone = true;
        break;
    case tosps_Destroy:
        // Only used when an object is deleted effectively without passing through dying, e.g. egg object on hatch
        m_StepDone = true;
        break;
    default:
        m_OurLandscape->Warn("Spider Egg - unknown state", NULL);
        exit(1);
    }
}

References Spider_Base::m_CurrentSpState, TALMaSSObject::m_CurrentStateNo, TAnimal::m_OurLandscape, TALMaSSObject::m_StepDone, st_Develop(), st_Die(), st_Hatch(), tosps_Destroy, tosps_Develop, tosps_Dying, tosps_Hatch, tosps_Initiation, and Landscape::Warn().

Member Data Documentation

m_DailyEggMortConst

int Spider_Egg::m_DailyEggMortConst = 0

static

This is a space for holding cfg species specific parameters - this is the daily egg mortality probability Spider_Egg::st_Develop.

Referenced by Erigone_Population_Manager::Init(), Oedothorax_Population_Manager::Init(), and st_Develop().

m_DateLaid

int Spider_Egg::m_DateLaid

protected

The day in year the eggsac was produced

Referenced by ReInit(), Spider_Egg(), and st_Develop().

m_EggDevelConst

double Spider_Egg::m_EggDevelConst = 0

static

This is a space for holding cfg species specific parameters - this is a developmental threshold for hatch in Spider_Egg::st_Develop.

Referenced by Erigone_Population_Manager::Init(), Oedothorax_Population_Manager::Init(), and st_Develop().

m_HatDensityDepMortConst

int Spider_Egg::m_HatDensityDepMortConst = 0

static

This is a space for holding cfg species specific parameters - this is the mortality constant associated with Spider_Egg::Hatch.

Referenced by Erigone_Population_Manager::Init(), Oedothorax_Population_Manager::Init(), and st_Hatch().

m_NoEggs

int Spider_Egg::m_NoEggs

protected

The number of eggs contained in the eggsac

Referenced by GetNoEggs(), ReInit(), SetNoEggs(), Spider_Egg(), and st_Hatch().

---

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

• /builds/ALMaSS/ALMaSS_MIDox/Spiders/Spider_BaseClasses.h
• /builds/ALMaSS/ALMaSS_MIDox/Spiders/Spider_BaseClasses.cpp