ALMaSS: Spider_Population_Manager Class Reference

•All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages

#include <Spider_BaseClasses.h>

Inheritance diagram for Spider_Population_Manager:

Public Member Functions
int	GetEggSacSpread ()
	Return the EggSacSpread value More...

int	GetDoubleEggSacSpread ()
	Return 2 x EggSacSpread value More...

double	GetBallooningMortalityPerMeter ()
	Return ballooning mortality per meter More...

int	GetDaysSinceRain ()
	Return the number of days since rain More...

int	GetTodaysMonth ()
	Return current month More...

double	GetTodaysDroughtSc (int index)
	Returns the drought score for high, medium or low plant biomass More...

double	GetJuvMort ()
	Return current juvenile mortality rate More...

int	GetDispDist (int chance)
	Returns the dispsersal distance associated with a particular frequency value More...

double	GetBTime (int day)
	Returns ballooning hours for a given day More...

double	GetBTimeToday ()
	Returns todays ballooning time More...

int	GetWindDirection ()
	Returns the wind direction More...

bool	IsBallooningWeather ()
	Returns the flag for ballooning weather More...

double	GetEggDegreesPoor ()
	Returns todays egg sac production day degrees for poor food More...

double	GetEggDegreesInt ()
	Returns todays egg sac production day degrees for intermediate food More...

double	GetEggDegreesGood ()
	Returns todays egg sac production day degrees for good food More...

double	GetJuvDegrees_good ()
	Returns todays juvenile development day degrees for good food More...

double	GetJuvDegrees_intermediate ()
	Returns todays juvenile development day degrees for intermediate food More...

double	GetJuvDegrees_poor ()
	Returns todays juvenile development day degrees for poor food More...

double	GetEggDevelDegrees (int day)
	Returns todays egg development day degrees More...

bool	CheckHumidity (int, int)
	Returns humid or not More...

bool	GetWalking ()
	Returns walking only flag More...

bool	GetMinWalkTemp ()
	Returns the minimum walking temperature More...

	Spider_Population_Manager (Landscape *p_L, int N)
	The constructor More...

virtual void	Init (void)
	An initiation method to initialise all the necessary values - must be overridden for species specific functionality More...

virtual void	DoFirst (void)
	DoFirst method, to be overridden in descendent classes More...

virtual	~Spider_Population_Manager ()
	Destructor More...

virtual void	TheAOROutputProbe ()
	A method to generate the AOR probe output More...

virtual void	TheRipleysOutputProbe (FILE *a_prb)
	A method to generate the Ripley probe output More...

bool	InSquare (int p_x, int p_y, int p_sqx, int p_sqy, int p_range)
	Returns true if p_x,p_y is inside the square defined by p_sqz,p_sqy as TL corner and p_range size length More...

virtual void	Catastrophe ()
	Allows for the possibility to create population level mortality More...

virtual void	CreateObjects (int ob_type, TAnimal pvo, struct_Spider data, int number)
	Creates new spider objects - this must be overridden in descendent classes More...

Public Member Functions inherited from Population_Manager
	Population_Manager (Landscape *a_l_ptr, int a_numberLifeStages=12)

virtual	~Population_Manager (void)

void	SetNoProbesAndSpeciesSpecificFunctions (int a_pn) override
	Sets up probe and species specifics. More...

void	OpenTheAOROutputProbe (const string &a_AORFilename) override
	Opens the AOR output file. More...

unsigned	GetLiveArraySize (int a_listindex) override
	Gets the number of 'live' objects for a list index in the TheArray. More...

unsigned	GetPopulationSize (int a_listindex) override
	Gets the number of species objects by default it is the same as LiveArray, however it could be different. This function should be used/overriden when we are interested in the number of the objects for presentation and not in inner maintenance of the PopulationManager and or TheArray. More...

void	IncLiveArraySize (int a_listindex)
	Increments the number of 'live' objects for a list index in the TheArray. More...

unsigned int	FarmAnimalCensus (unsigned int a_farm, unsigned int a_typeofanimal)

char *	SpeciesSpecificReporting (int a_species, int a_time) override

char *	ProbeReport (int a_time)

char *	ProbeReportTimed (int a_time)

void	ImpactProbeReport (int a_Time)

bool	BeginningOfMonth ()

void	LOG (const char *fname)

int	SupplyStepSize () const

void	Run (int NoTSteps) override

virtual unsigned	Probe (int ListIndex, Probe_Data *p_TheProbe)

virtual void	ImpactedProbe ()

virtual TAnimal *	SupplyAnimalPtr (unsigned int a_index, unsigned int a_animal)
	Returns the pointer indexed by a_index and a_animal. Note NO RANGE CHECK. More...

virtual unsigned	SupplyListIndexSize ()

unsigned	SupplyListSize (unsigned listindex) const

void	PushIndividual (const unsigned a_listindex, TAnimal *a_individual_ptr)

const char *	SupplyStateNames (int i) const

unsigned	SupplyStateNamesLength () const

virtual void	DisplayLocations ()

TAnimal *	FindIndividual (unsigned Type, TAnimal *a_me)

virtual TAnimal *	FindClosest (int x, int y, unsigned Type, TAnimal *a_me)

omp_nest_lock_t *	GetGuardMapElement (unsigned a_x_index, unsigned a_y_index)
	Return the guard map cell. More...

void	SetGuardMapElement (unsigned a_x_index, unsigned a_y_index)
	Set the given guard map cell. More...

void	UnsetGuardMapElement (unsigned a_x_index, unsigned a_y_index)
	Unset the given guard map cell. More...

void	UpdateGuardMap (int a_x, int a_y, int &a_index_x, int &a_index_y)
	Get the index of the guard map for the given location. More...

bool	OpenTheRipleysOutputProbe ()

bool	OpenTheMonthlyRipleysOutputProbe ()

bool	OpenTheReallyBigProbe ()

virtual void	TheRipleysOutputProbe (ofstream *a_prb)
	Special output functionality. More...

virtual void	TheReallyBigOutputProbe ()

void	CloseTheMonthlyRipleysOutputProbe () const

virtual void	CloseTheRipleysOutputProbe ()

virtual void	CloseTheReallyBigOutputProbe ()

TTypesOfPopulation	GetPopulationType ()

int	GetSeasonNumber ()
	Get the season number. More...

void	LamdaDeath (int x, int y)

void	LamdaBirth (int x, int y)

void	LamdaBirth (int x, int y, int z)

void	LamdaClear ()

void	LamdaDumpOutput ()

virtual int	SupplyPegPosx (int)

virtual int	SupplyPegPosy (int)

virtual int	SupplyCovPosx (int)

virtual int	SupplyCovPosy (int)

virtual bool	OpenTheFledgelingProbe ()

virtual bool	OpenTheBreedingPairsProbe ()

virtual bool	OpenTheBreedingSuccessProbe ()

virtual void	BreedingPairsOutput (int)

virtual int	TheBreedingFemalesProbe (int)

virtual int	TheFledgelingProbe ()

virtual void	BreedingSuccessProbeOutput (double, int, int, int, int, int, int, int)

virtual int	TheBreedingSuccessProbe (int &, int &, int &, int &, int &, int &)

virtual void	FledgelingProbeOutput (int, int)

virtual void	TheGeneticProbe (unsigned, int, unsigned &)

virtual void	GeneticsResultsOutput (FILE *, unsigned)

void	Debug_Shuffle (unsigned int Type)

virtual void	RunStepMethods ()

Public Member Functions inherited from Population_Manager_Base
	Population_Manager_Base (Landscape *L)
	The Population_Manager_Base constructor. More...

virtual void	Catastrophe (int)
	Must be re-implemented in descendent classes. More...

int	SupplySimW () const
	Returns landscape width in m. More...

int	SupplySimH () const
	Returns landscape height in m. More...

int	SupplySimWH () const
	Returns half the landscape width in m. More...

int	SupplySimHH () const
	Returns half the landscape height in m. More...

virtual int	ProbeFileInput (char *p_Filename, int p_ProbeNo)
	A stub to build specfic probes and functions. More...

int	SupplyListNameLength () const

const char *	SupplyListName (int a_i) const
	Get a list name from the list. More...

virtual void	SupplyLocXY (unsigned, unsigned, int &, int &)
	A stub for identifying an individual at a location. More...

virtual TAnimal *	FindClosest (int, int, unsigned)
	A stub for identifying an individual at a location. More...

std::string	SupplySimulationName ()

void	SetStepCounterInADay (int a_counter)
	Set step counter in a day. More...

int	GetStepCounterInADay (void)
	Return the sep counter in a day. More...

virtual double	GetAphidDensity (int, int)
	Return the aphid density, it is only used when aphid simulations are running. More...

Public Attributes
MovementMapUnsigned *	m_MoveMap
	A representation of the landscape in terms of quality - NB MUST be assigned by the descendent population manager class Init() method More...

SimplePositionMap *	m_EggPosMap
	Pointer to the egg position map More...

SimplePositionMap *	m_JuvPosMap
	Pointer to the egg position map More...

SimplePositionMap *	m_AdultPosMap
	Pointer to the egg position map More...

Public Attributes inherited from Population_Manager
bool	ProbesSet {}

Public Attributes inherited from Population_Manager_Base
Probe_Data *	TheProbe [100] = {nullptr}
	Holds a list of pointers to standard output probes. More...

Static Public Attributes
static std::array< int, 31 >	m_DispDistances
	An array to hold the dispersal distances possible as a probability 0-30 (x out of 10000) More...

Protected Attributes
double	m_DailyJuvMort
	The daily probability of a juvenile dying - to be assigned in a descendent classes population manager More...

int	m_DispersalDistances [10000]
	The distribution of dispersal distances - to be assigned in a descendent classes population manager More...

double	BallooningHrs [52 *7]
	The daily number of ballooning hours - to be assigned in a descendent classes population manager More...

int	m_DaysSinceRain
	The number of days since last rain More...

int	m_TodaysMonth
	Holds the current month More...

double	m_TodaysDroughtScore [3]
	Holds the current drought score for three vegetation classes More...

double	m_TodaysBallooningTime
	The current day's ballooning time More...

int	m_EggSacSpread
	Used to spread spiderlings on day 1 of hatch - to be assigned in a descendent classes population manager More...

int	m_DoubleEggSacSpread
	Twice the m_EggSacSpread, used to save multiplications More...

double	m_BallooningMortalityPerMeter
	The mortality of ballooned distance - to be assigned in a descendent classes population manager More...

bool	m_EggProdThresholdPassed
	A flag for passing minimum temperature for producing eggs. More...

int	m_WindDirection
	Todays wind direction More...

bool	m_BallooningWeather
	A flag for whether the weather is correct for ballooning More...

int	m_BallooningStart
	A limiter for the day in year to start ballooning - to be assigned in a descendent classes population manager More...

int	m_BallooningStop
	A limiter for the day in year to stop ballooning - to be assigned in a descendent classes population manager More...

double	m_EggDevelopmentThreshold
	The lower threshold for egg development - to be assigned in a descendent classes population manager More...

double	m_EggDevelopmentThreshold2
	The upper threshold for egg development - to be assigned in a descendent classes population manager More...

double	m_EggDegrees [365]
	Cumulative day degrees from 1st Jan More...

double	m_JuvDegreesGood
	Contribution to day degrees under good food. More...

double	m_JuvDegreesIntermediate
	Contribution to day degrees under intermediate food More...

double	m_JuvDegreesPoor
	Contribution to day degrees under poor food More...

double	m_EggProdDDegsGood
	Links reproduction to food levels and day degrees - good food. More...

double	m_EggProdDDegsInt
	Links reproduction to food levels and day degrees - intermediate food More...

double	m_EggProdDDegsPoor
	Links reproduction to food levels and day degrees - poor food More...

bool	m_WalkingOnly
	A flag to denote the spider does not balloon More...

bool	m_MinWalkTemp
	A flag to show whether minimum walking temperature is reached More...

double	m_MinWalkTempThreshold
	A minimum dispersal by walking temperature More...

Protected Attributes inherited from Population_Manager
vector< unsigned >	m_LiveArraySize

int	m_NoProbes = 0

std::vector< std::vector< omp_nest_lock_t * > >	m_MapGuard
	This is used to make sure animals will not behaviour at the same area - multi threads. More...

int	m_guard_cell_height_num

int	m_guard_cell_width_num

int	m_guard_cell_size

bool	m_is_paralleled
	This is used to indicate whether the species is paralleled. More...

const char *	StateNames [100] {}

int	m_StepSize {}

vector< vector< forward_list< TAnimal * > * > >	TheSubArrays
	Hold all the animal pointers. More...

vector< vector< int > >	TheSubArraysSizes
	Hold all the animal sizes in each thread. More...

vector< int >	m_LifeStageOrderVec
	The vector to store the life stage order for looping specie life stages. More...

vector< forward_list< TAnimal * >::iterator >	TheSubArraysIterators
	the iterator from last time called for SupplyAnimalPtr(), this for fast loop all the animals in the derived class. More...

vector< int >	TheSubArrayPreviousIndex
	the animal index number from last time called for SupplyAnimalPtr(), this for fast loop all the animals in the derived class. More...

vector< int >	TheSubArrayThreadIndex
	the thread index number from last time called for SupplyAnimalPtr(), this for fast loop all the animals in the derived class. More...

unsigned	StateNamesLength

FILE *	TestFile {}

FILE *	TestFile2 {}

vector< unsigned >	BeforeStepActions
	Holds the season list of possible before step actions. More...

int	m_SeasonNumber
	Holds the season number. Used when running goose and hunter sims. More...

TTypesOfPopulation	m_population_type {TOP_NoSpecies}

ofstream *	AOROutputPrb {}

ofstream *	RipleysOutputPrb {}

ofstream *	RipleysOutputPrb1 {}

ofstream *	RipleysOutputPrb2 {}

ofstream *	RipleysOutputPrb3 {}

ofstream *	RipleysOutputPrb4 {}

ofstream *	RipleysOutputPrb5 {}

ofstream *	RipleysOutputPrb6 {}

ofstream *	RipleysOutputPrb7 {}

ofstream *	RipleysOutputPrb8 {}

ofstream *	RipleysOutputPrb9 {}

ofstream *	RipleysOutputPrb10 {}

ofstream *	RipleysOutputPrb11 {}

ofstream *	RipleysOutputPrb12 {}

ofstream *	ReallyBigOutputPrb {}

AOR_Probe *	m_AOR_Probe {}
	A pointer to the AOR probe. More...

long int	lamdagrid [2][257][257] {}

Protected Attributes inherited from Population_Manager_Base
int	SimH
	stores the simulation height More...

int	SimW
	stores the simulation width More...

int	SimHH
	stores the simulation height halved More...

int	SimWH
	stores the simulation width halved More...

string	m_SimulationName
	stores the simulation name More...

Landscape *	m_TheLandscape
	holds an internal pointer to the landscape More...

int	m_ListNameLength {}
	the number of life-stages simulated in the population manager More...

const char *	m_ListNames [32] {}
	A list of life-stage names. More...

std::string	m_AORProbeFileName {"AOR_Probe.txt"}
	name of the AOR Probe file More...

std::string	m_ProbeFileName {"Probe.res"}
	name of the Probe file More...

int	m_step_counter_in_a_day
	Step counter in a day, this is used for the animals with finer step size other than one day. More...

Additional Inherited Members
Protected Member Functions inherited from Population_Manager
virtual bool	StepFinished ()
	Methods to run the simulations. More...

virtual void	DoBefore ()

virtual void	DoAfter ()

virtual void	DoLast ()

virtual void	DoSpecialBetweenLifeStages (int a_life_stage)

virtual void	SortX (unsigned Type)

void	SortXIndex (unsigned Type)

virtual void	SortY (unsigned Type)

void	SortState (unsigned Type)

void	SortStateR (unsigned Type)

virtual unsigned	PartitionLiveDead (unsigned Type)

virtual void	Shuffle_or_Sort (unsigned Type)

virtual void	Shuffle (unsigned Type)

Protected Member Functions inherited from Population_Manager_Base
	~Population_Manager_Base ()=default

Constructor & Destructor Documentation

◆ Spider_Population_Manager()

Spider_Population_Manager::Spider_Population_Manager	(	Landscape *	p_L,
		int	N
	)

The constructor

                                                                           : Population_Manager(p_L, N)
 {
  
     m_is_paralleled = true; //all spiders are parallelized
     m_AdultPosMap = new SimplePositionMap(m_TheLandscape);
     m_JuvPosMap = new SimplePositionMap(m_TheLandscape);
     m_EggPosMap = new SimplePositionMap(m_TheLandscape);
     // Other variables
     m_MinWalkTemp = false;
     // Load List of Animal Classes
     m_ListNames[0] = "Egg";
     m_ListNames[1] = "Juvenile";
     m_ListNames[2] = "Female";
     m_ListNameLength = 3;
  
     // Load State Names
     StateNames[tosps_Initiation] = "Initiation";
     // Egg
     StateNames[tosps_Develop] = "Developing";
     StateNames[tosps_Hatch] = "Hatching";
     StateNames[tosps_Dying] = "Dying";
     // Juvenile
     StateNames[tosps_Develop] = "Developing";
     StateNames[tosps_JBalloon] = "Ballooning";
     StateNames[tosps_AssessHabitat] = "AssessHabitat";
     StateNames[tosps_Mature] = "Maturation";
     StateNames[tosps_Dying] = "Dying";
     // Female
     StateNames[tosps_Reproduce] = "Reproduce";
     StateNames[tosps_FBalloon] = "Ballooning";
     StateNames[tosps_Dying] = "Dying";
     // Destroy
     StateNames[tosps_Destroy] = "Destroy";
     // Ensure that spider's execution order is shuffled after each time step
     // or do nothing if that is prefered
     BeforeStepActions[0] = 0; // 0 = Shuffle, 1 = SortX, 2 = SortY, 3 = do nothing
     BeforeStepActions[1] = 0; // 0 = Shuffle, 1 = SortX, 2 = SortY, 3 = do nothing
     BeforeStepActions[2] = 0; // 0 = Shuffle, 1 = SortX, 2 = SortY, 3 = do nothing
  
     m_BallooningWeather = false;
  
     // Zero the egg degrees
     for (int i = 0; i < 365; i++) m_EggDegrees[i] = 0;
     // 3. Dispersal Time
     int count = 0;
     for (int i = 0; i < 52; i++)
         for (int j = 0; j < 7; j++)
         {
             BallooningHrs[count++] = BallooningHours[i];
         }
     // Zero the rain counter
     //m_DaysSinceRain = 0;
  
     // Default set spiders to walking
     m_WalkingOnly = true;
     // Set out value for juv mort
     m_EggProdThresholdPassed = false;
     m_EggProdDDegsPoor = 0;
     m_EggProdDDegsInt = 0;
     m_EggProdDDegsGood = 0;
 #ifdef __RECORD_RECOVERY_POLYGONS
     /* Open the output file and append */
     ofstream ofile("RecoveryPolygonsCounter.txt", ios::out);
     ofile << "This file records the number of females in each polygon each day" << endl;
     ofile.close();
     /* Open the polygon recovery file and read in polygons to m_RecoveryPolygons */
     ifstream ifile("RecoveryPolygonsList.txt", ios::in);
     int n;
     ifile >> n;
     m_RecoveryPolygons[0] = n;
     for (int i = 0; i < n; i++) ifile >> m_RecoveryPolygons[1 + i];
     for (int i = 0; i < n; i++) m_RecoveryPolygonsC[1 + i] = 0;
     ifile.close();
 #endif
 #ifdef __SpidDebug
     for (int i=0; i<10; i++) m_Deaths[i] = 0;
     m_JDeaths = 0;
     m_Mature = 0;
 #endif
 }

References BallooningHours, BallooningHrs, Population_Manager::BeforeStepActions, count, m_AdultPosMap, m_BallooningWeather, m_EggDegrees, m_EggPosMap, m_EggProdDDegsGood, m_EggProdDDegsInt, m_EggProdDDegsPoor, m_EggProdThresholdPassed, Population_Manager::m_is_paralleled, m_JuvPosMap, Population_Manager_Base::m_ListNameLength, Population_Manager_Base::m_ListNames, m_MinWalkTemp, Population_Manager_Base::m_TheLandscape, m_WalkingOnly, Population_Manager::StateNames, tosps_AssessHabitat, tosps_Destroy, tosps_Develop, tosps_Dying, tosps_FBalloon, tosps_Hatch, tosps_Initiation, tosps_JBalloon, tosps_Mature, and tosps_Reproduce.

◆ ~Spider_Population_Manager()

Spider_Population_Manager::~Spider_Population_Manager ( )

virtual

Destructor

 {
     delete m_AdultPosMap;
     delete m_JuvPosMap;
     delete m_EggPosMap;
 }

References m_AdultPosMap, m_EggPosMap, and m_JuvPosMap.

Member Function Documentation

◆ Catastrophe()

virtual void Spider_Population_Manager::Catastrophe ( void )

inlinevirtual

Allows for the possibility to create population level mortality

Reimplemented from Population_Manager.

Reimplemented in Oedothorax_Population_Manager, and Erigone_Population_Manager.

271 { ; }

◆ CheckHumidity()

bool Spider_Population_Manager::CheckHumidity	(	int	,
		int
	)

inline

Returns humid or not

248 {

249 return true; } // TODO

Referenced by Spider_Juvenile::AssessHabitat().

◆ CreateObjects()

virtual void Spider_Population_Manager::CreateObjects	(	int	ob_type,
		TAnimal *	pvo,
		struct_Spider *	data,
		int	number
	)

inlinevirtual

Creates new spider objects - this must be overridden in descendent classes

Reimplemented in Oedothorax_Population_Manager, and Erigone_Population_Manager.

273 { ; }

Referenced by Spider_Female::CreateEggSac(), Spider_Egg::Hatch(), and Spider_Juvenile::Maturation().

◆ DoFirst()

virtual void Spider_Population_Manager::DoFirst ( void )

inlinevirtual

DoFirst method, to be overridden in descendent classes

Reimplemented from Population_Manager.

Reimplemented in Oedothorax_Population_Manager, and Erigone_Population_Manager.

261 { ; }

◆ GetBallooningMortalityPerMeter()

double Spider_Population_Manager::GetBallooningMortalityPerMeter ( )

inline

Return ballooning mortality per meter

                                              {
          return m_BallooningMortalityPerMeter;
      }

References m_BallooningMortalityPerMeter.

Referenced by Spider_Juvenile::BallooningMortality().

◆ GetBTime()

double Spider_Population_Manager::GetBTime ( int day )

inline

Returns ballooning hours for a given day

                               {
          return BallooningHrs[day];
      }

References BallooningHrs.

◆ GetBTimeToday()

double Spider_Population_Manager::GetBTimeToday ( )

inline

Returns todays ballooning time

218 {

219 return m_TodaysBallooningTime; }

References m_TodaysBallooningTime.

Referenced by Spider_Juvenile::Balloon().

◆ GetDaysSinceRain()

int Spider_Population_Manager::GetDaysSinceRain ( )

inline

Return the number of days since rain

                             {
          return m_DaysSinceRain;
      }

References m_DaysSinceRain.

◆ GetDispDist()

int Spider_Population_Manager::GetDispDist ( int chance )

inline

Returns the dispsersal distance associated with a particular frequency value

                                  {
          return m_DispersalDistances[chance];
      }

References m_DispersalDistances.

Referenced by Spider_Juvenile::Balloon().

◆ GetDoubleEggSacSpread()

int Spider_Population_Manager::GetDoubleEggSacSpread ( )

inline

Return 2 x EggSacSpread value

                                         {
          return m_DoubleEggSacSpread;
      }

References m_DoubleEggSacSpread.

Referenced by Spider_Egg::st_Hatch().

◆ GetEggDegreesGood()

double Spider_Population_Manager::GetEggDegreesGood ( )

inline

Returns todays egg sac production day degrees for good food

233 {

234 return m_EggProdDDegsGood; }

References m_EggProdDDegsGood.

Referenced by Spider_Female::st_Reproduce().

◆ GetEggDegreesInt()

double Spider_Population_Manager::GetEggDegreesInt ( )

inline

Returns todays egg sac production day degrees for intermediate food

230 {

231 return m_EggProdDDegsInt; }

References m_EggProdDDegsInt.

Referenced by Spider_Female::st_Reproduce().

◆ GetEggDegreesPoor()

double Spider_Population_Manager::GetEggDegreesPoor ( )

inline

Returns todays egg sac production day degrees for poor food

227 {

228 return m_EggProdDDegsPoor; }

References m_EggProdDDegsPoor.

Referenced by Spider_Female::st_Reproduce().

◆ GetEggDevelDegrees()

double Spider_Population_Manager::GetEggDevelDegrees ( int day )

inline

Returns todays egg development day degrees

245 {

246 return m_EggDegrees[day]; }

References m_EggDegrees.

Referenced by Spider_Egg::st_Develop().

◆ GetEggSacSpread()

int Spider_Population_Manager::GetEggSacSpread ( )

inline

Return the EggSacSpread value

                                   {
          return m_EggSacSpread;
      }

References m_EggSacSpread.

Referenced by Spider_Egg::st_Hatch().

◆ GetJuvDegrees_good()

double Spider_Population_Manager::GetJuvDegrees_good ( )

inline

Returns todays juvenile development day degrees for good food

236 {

237 return m_JuvDegreesGood; }

References m_JuvDegreesGood.

Referenced by Spider_Juvenile::st_Develop().

◆ GetJuvDegrees_intermediate()

double Spider_Population_Manager::GetJuvDegrees_intermediate ( )

inline

Returns todays juvenile development day degrees for intermediate food

239 {

240 return m_JuvDegreesIntermediate; }

References m_JuvDegreesIntermediate.

Referenced by Spider_Juvenile::st_Develop().

◆ GetJuvDegrees_poor()

double Spider_Population_Manager::GetJuvDegrees_poor ( )

inline

Returns todays juvenile development day degrees for poor food

242 {

243 return m_JuvDegreesPoor; }

References m_JuvDegreesPoor.

Referenced by Spider_Juvenile::st_Develop().

◆ GetJuvMort()

double Spider_Population_Manager::GetJuvMort ( )

inline

Return current juvenile mortality rate

207 {

208 return m_DailyJuvMort; }

References m_DailyJuvMort.

Referenced by Spider_Juvenile::st_Develop().

◆ GetMinWalkTemp()

bool Spider_Population_Manager::GetMinWalkTemp ( )

inline

Returns the minimum walking temperature

254 {

255 return m_MinWalkTemp; }

References m_MinWalkTemp.

Referenced by Spider_Juvenile::Walk().

◆ GetTodaysDroughtSc()

double Spider_Population_Manager::GetTodaysDroughtSc ( int index )

inline

Returns the drought score for high, medium or low plant biomass

204 {

205 return m_TodaysDroughtScore[index]; }

References m_TodaysDroughtScore.

Referenced by Erigone_Juvenile::CalcDrought(), Oedothorax_Juvenile::CalcDrought(), Oedothorax_Female::CalcDrought(), and Erigone_Female::CalcDrought().

◆ GetTodaysMonth()

int Spider_Population_Manager::GetTodaysMonth ( )

inline

Return current month

201 {

202 return m_TodaysMonth; }

References m_TodaysMonth.

Referenced by Erigone_Female::CalculateEggsPerEggSac(), and Oedothorax_Female::CalculateEggsPerEggSac().

◆ GetWalking()

bool Spider_Population_Manager::GetWalking ( )

inline

Returns walking only flag

251 {

252 return m_WalkingOnly; }

References m_WalkingOnly.

Referenced by Spider_Juvenile::Step(), and Spider_Female::Step().

◆ GetWindDirection()

int Spider_Population_Manager::GetWindDirection ( )

inline

Returns the wind direction

221 {

222 return m_WindDirection; }

References m_WindDirection.

Referenced by Spider_Juvenile::Balloon().

◆ Init()

void Spider_Population_Manager::Init ( void )

virtual

An initiation method to initialise all the necessary values - must be overridden for species specific functionality

Reimplemented in Oedothorax_Population_Manager, and Erigone_Population_Manager.

 {
     ;
 }

◆ InSquare()

bool Spider_Population_Manager::InSquare	(	int	p_x,
		int	p_y,
		int	p_sqx,
		int	p_sqy,
		int	p_range
	)

Returns true if p_x,p_y is inside the square defined by p_sqz,p_sqy as TL corner and p_range size length

 {
     // Simply checks if co-ordinates p_x,p_y are in the square formed by
     // p_sqx,p_sqy,p_sqx+p_range,p_sqy+p_range
     // The function is long but reasonably efficient - I think
  
     int x_extent = p_sqx + p_range;
     int y_extent = p_sqy + p_range;
     if (x_extent >= SimW)
     {
         if (y_extent >= SimH)  // overlaps TR corner of sim area
         {
             // Top right square (limited by SimAreaHeight & SimAreaWidth
             if ((p_x >= p_sqx) && (p_y >= p_sqy)) return true;
             // Top Left Square (limited by 0,SimAreaHeight)
             if ((p_y >= p_sqy) && (p_y < y_extent - SimH)) return true;
             // Bottom Left square (limited by 0,0)
             if ((p_x >= x_extent - SimW) &&
                 (p_y < y_extent - SimH)) return true;
             // Bottom Right square (limited by SimAreaWidth,0)
             if ((p_x >= p_sqx) && (p_y < y_extent - SimH)) return true;
  
         }
         else // Overlaps the west edge of the sim area
         {
             if ((p_x >= p_sqx) && (p_y >= p_sqy) && (p_y < y_extent)) return true;
             if ((p_x < x_extent - SimW) && (p_y >= p_sqy) && (p_y < y_extent)) return true;
         }
     }
     else
     {
         if (y_extent >= SimH) // overlaps top of simulation area
         {
             if ((p_x >= p_sqx) && (p_x < x_extent) &&
                 (p_y >= p_sqy)) return true;
             if ((p_x >= p_sqx) && (p_x < x_extent) &&
                 (p_y < y_extent - SimH)) return true;
         }
         else // territory does not overlap end of simulation area
         {
             if ((p_x >= p_sqx) && (p_x < x_extent) &&
                 (p_y >= p_sqy) && (p_y < y_extent)) return true;
         }
     }
     return false; // not in territory
 }

References Population_Manager_Base::SimH, and Population_Manager_Base::SimW.

◆ IsBallooningWeather()

bool Spider_Population_Manager::IsBallooningWeather ( )

inline

Returns the flag for ballooning weather

224 {

225 return m_BallooningWeather; };

References m_BallooningWeather.

Referenced by Spider_Juvenile::AssessHabitat().

◆ TheAOROutputProbe()

virtual void Spider_Population_Manager::TheAOROutputProbe ( )

inlinevirtual

A method to generate the AOR probe output

Reimplemented from Population_Manager.

Reimplemented in Oedothorax_Population_Manager, and Erigone_Population_Manager.

265 { ; }

◆ TheRipleysOutputProbe()

virtual void Spider_Population_Manager::TheRipleysOutputProbe ( FILE * a_prb )

inlinevirtual

A method to generate the Ripley probe output

Reimplemented in Oedothorax_Population_Manager, and Erigone_Population_Manager.

267 { ; }

Member Data Documentation

◆ BallooningHrs

double Spider_Population_Manager::BallooningHrs[52 *7]

protected

The daily number of ballooning hours - to be assigned in a descendent classes population manager

Referenced by Oedothorax_Population_Manager::DoFirst(), GetBTime(), and Spider_Population_Manager().

◆ m_AdultPosMap

SimplePositionMap* Spider_Population_Manager::m_AdultPosMap

Pointer to the egg position map

Referenced by Erigone_Population_Manager::Init(), Oedothorax_Population_Manager::Init(), Spider_Juvenile::Maturation(), Spider_Female::ReInit(), Spider_Female::Spider_Female(), Spider_Population_Manager(), and ~Spider_Population_Manager().

◆ m_BallooningMortalityPerMeter

double Spider_Population_Manager::m_BallooningMortalityPerMeter

protected

The mortality of ballooned distance - to be assigned in a descendent classes population manager

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

◆ m_BallooningStart

int Spider_Population_Manager::m_BallooningStart

protected

A limiter for the day in year to start ballooning - to be assigned in a descendent classes population manager

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

◆ m_BallooningStop

int Spider_Population_Manager::m_BallooningStop

protected

A limiter for the day in year to stop ballooning - to be assigned in a descendent classes population manager

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

◆ m_BallooningWeather

bool Spider_Population_Manager::m_BallooningWeather

protected

A flag for whether the weather is correct for ballooning

Referenced by IsBallooningWeather(), and Spider_Population_Manager().

◆ m_DailyJuvMort

double Spider_Population_Manager::m_DailyJuvMort

protected

The daily probability of a juvenile dying - to be assigned in a descendent classes population manager

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), GetJuvMort(), Erigone_Population_Manager::Init(), and Oedothorax_Population_Manager::Init().

◆ m_DaysSinceRain

int Spider_Population_Manager::m_DaysSinceRain

protected

The number of days since last rain

Referenced by GetDaysSinceRain().

◆ m_DispDistances

std::array< int, 31 > Spider_Population_Manager::m_DispDistances

static

Initial value:

=
{
    3,   11,   29,   71,  136,  235,  405,  673, 1054, 1567,
 2185, 2906, 3748, 4693, 5528, 6423, 7226, 7926, 8543, 8990,
 9360, 9614, 9782, 9882, 9950, 9979, 9991, 9997, 9999, 9999,
 10000
}

An array to hold the dispersal distances possible as a probability 0-30 (x out of 10000)

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

◆ m_DispersalDistances

int Spider_Population_Manager::m_DispersalDistances[10000]

protected

The distribution of dispersal distances - to be assigned in a descendent classes population manager

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

◆ m_DoubleEggSacSpread

int Spider_Population_Manager::m_DoubleEggSacSpread

protected

Twice the m_EggSacSpread, used to save multiplications

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

◆ m_EggDegrees

double Spider_Population_Manager::m_EggDegrees[365]

protected

Cumulative day degrees from 1st Jan

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), GetEggDevelDegrees(), and Spider_Population_Manager().

◆ m_EggDevelopmentThreshold

double Spider_Population_Manager::m_EggDevelopmentThreshold

protected

The lower threshold for egg development - to be assigned in a descendent classes population manager

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

◆ m_EggDevelopmentThreshold2

double Spider_Population_Manager::m_EggDevelopmentThreshold2

protected

The upper threshold for egg development - to be assigned in a descendent classes population manager

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

◆ m_EggPosMap

SimplePositionMap* Spider_Population_Manager::m_EggPosMap

Pointer to the egg position map

Referenced by Spider_Female::CreateEggSac(), Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), Spider_Female::ProduceEggSac(), Spider_Egg::ReInit(), Spider_Egg::Spider_Egg(), Spider_Population_Manager(), Spider_Egg::st_Die(), Spider_Egg::st_Hatch(), and ~Spider_Population_Manager().

◆ m_EggProdDDegsGood

double Spider_Population_Manager::m_EggProdDDegsGood

protected

Links reproduction to food levels and day degrees - good food.

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), GetEggDegreesGood(), and Spider_Population_Manager().

◆ m_EggProdDDegsInt

double Spider_Population_Manager::m_EggProdDDegsInt

protected

Links reproduction to food levels and day degrees - intermediate food

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), GetEggDegreesInt(), and Spider_Population_Manager().

◆ m_EggProdDDegsPoor

double Spider_Population_Manager::m_EggProdDDegsPoor

protected

Links reproduction to food levels and day degrees - poor food

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), GetEggDegreesPoor(), and Spider_Population_Manager().

◆ m_EggProdThresholdPassed

bool Spider_Population_Manager::m_EggProdThresholdPassed

protected

A flag for passing minimum temperature for producing eggs.

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), and Spider_Population_Manager().

◆ m_EggSacSpread

int Spider_Population_Manager::m_EggSacSpread

protected

Used to spread spiderlings on day 1 of hatch - to be assigned in a descendent classes population manager

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

◆ m_JuvDegreesGood

double Spider_Population_Manager::m_JuvDegreesGood

protected

Contribution to day degrees under good food.

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), and GetJuvDegrees_good().

◆ m_JuvDegreesIntermediate

double Spider_Population_Manager::m_JuvDegreesIntermediate

protected

Contribution to day degrees under intermediate food

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), and GetJuvDegrees_intermediate().

◆ m_JuvDegreesPoor

double Spider_Population_Manager::m_JuvDegreesPoor

protected

Contribution to day degrees under poor food

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), and GetJuvDegrees_poor().

◆ m_JuvPosMap

SimplePositionMap* Spider_Population_Manager::m_JuvPosMap

Pointer to the egg position map

Referenced by Spider_Egg::Hatch(), Spider_Juvenile::ReInit(), Spider_Juvenile::Spider_Juvenile(), Spider_Population_Manager(), and ~Spider_Population_Manager().

◆ m_MinWalkTemp

bool Spider_Population_Manager::m_MinWalkTemp

protected

A flag to show whether minimum walking temperature is reached

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), GetMinWalkTemp(), and Spider_Population_Manager().

◆ m_MinWalkTempThreshold

double Spider_Population_Manager::m_MinWalkTempThreshold

protected

A minimum dispersal by walking temperature

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

◆ m_MoveMap

MovementMapUnsigned* Spider_Population_Manager::m_MoveMap

A representation of the landscape in terms of quality - NB MUST be assigned by the descendent population manager class Init() method

Referenced by Spider_Juvenile::CheckToleTovIndex(), Erigone_Population_Manager::Init(), Oedothorax_Population_Manager::Init(), Erigone_Population_Manager::~Erigone_Population_Manager(), and Oedothorax_Population_Manager::~Oedothorax_Population_Manager().

◆ m_TodaysBallooningTime

double Spider_Population_Manager::m_TodaysBallooningTime

protected

The current day's ballooning time

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), and GetBTimeToday().

◆ m_TodaysDroughtScore

double Spider_Population_Manager::m_TodaysDroughtScore[3]

protected

Holds the current drought score for three vegetation classes

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), and GetTodaysDroughtSc().

◆ m_TodaysMonth

int Spider_Population_Manager::m_TodaysMonth

protected

Holds the current month

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), and GetTodaysMonth().

◆ m_WalkingOnly

bool Spider_Population_Manager::m_WalkingOnly

protected

A flag to denote the spider does not balloon

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), GetWalking(), and Spider_Population_Manager().

◆ m_WindDirection

int Spider_Population_Manager::m_WindDirection

protected

Todays wind direction

Referenced by Erigone_Population_Manager::DoFirst(), Oedothorax_Population_Manager::DoFirst(), and GetWindDirection().

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

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Spider_Population_Manager()

◆ ~Spider_Population_Manager()

Member Function Documentation

◆ Catastrophe()

◆ CheckHumidity()

◆ CreateObjects()

◆ DoFirst()

◆ GetBallooningMortalityPerMeter()

◆ GetBTime()

◆ GetBTimeToday()

◆ GetDaysSinceRain()

◆ GetDispDist()

◆ GetDoubleEggSacSpread()

◆ GetEggDegreesGood()

◆ GetEggDegreesInt()

◆ GetEggDegreesPoor()

◆ GetEggDevelDegrees()

◆ GetEggSacSpread()

◆ GetJuvDegrees_good()

◆ GetJuvDegrees_intermediate()

◆ GetJuvDegrees_poor()

◆ GetJuvMort()

◆ GetMinWalkTemp()

◆ GetTodaysDroughtSc()

◆ GetTodaysMonth()

◆ GetWalking()

◆ GetWindDirection()

◆ Init()

◆ InSquare()

◆ IsBallooningWeather()

◆ TheAOROutputProbe()

◆ TheRipleysOutputProbe()

Member Data Documentation

◆ BallooningHrs

◆ m_AdultPosMap

◆ m_BallooningMortalityPerMeter

◆ m_BallooningStart

◆ m_BallooningStop

◆ m_BallooningWeather

◆ m_DailyJuvMort

◆ m_DaysSinceRain

◆ m_DispDistances

◆ m_DispersalDistances

◆ m_DoubleEggSacSpread

◆ m_EggDegrees

◆ m_EggDevelopmentThreshold

◆ m_EggDevelopmentThreshold2

◆ m_EggPosMap

◆ m_EggProdDDegsGood

◆ m_EggProdDDegsInt

◆ m_EggProdDDegsPoor

◆ m_EggProdThresholdPassed

◆ m_EggSacSpread

◆ m_JuvDegreesGood

◆ m_JuvDegreesIntermediate

◆ m_JuvDegreesPoor

◆ m_JuvPosMap

◆ m_MinWalkTemp

◆ m_MinWalkTempThreshold

◆ m_MoveMap

◆ m_TodaysBallooningTime

◆ m_TodaysDroughtScore

◆ m_TodaysMonth

◆ m_WalkingOnly

◆ m_WindDirection